Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial Docs v1.0 #1

Merged
merged 54 commits into from
Apr 16, 2024
Merged
Show file tree
Hide file tree
Changes from 53 commits
Commits
Show all changes
54 commits
Select commit Hold shift + click to select a range
d2506dc
initial-commit
y0014984 Mar 6, 2024
7e16700
2024-03-06-a
y0014984 Mar 6, 2024
7599f83
2024-03-06-b
y0014984 Mar 6, 2024
7bf7417
fixed image link
y0014984 Mar 7, 2024
34faa9b
2024-03-07-a
y0014984 Mar 7, 2024
ce9427d
2024-03-11 a
y0014984 Mar 11, 2024
3683d5b
2024-03-11 b
y0014984 Mar 11, 2024
7a1d274
2024-03-15-a
y0014984 Mar 15, 2024
50c778e
added simple search bar
y0014984 Mar 16, 2024
07b5b07
2024-03-16-a
y0014984 Mar 16, 2024
fe7e106
2024-03-16-b
y0014984 Mar 16, 2024
7636e18
2024-03-18-a
y0014984 Mar 18, 2024
434155e
2024-03-18-b
y0014984 Mar 18, 2024
06066a8
2024-03-18-c
y0014984 Mar 18, 2024
57aca6e
2024-03-19-a
y0014984 Mar 19, 2024
10e888a
added image zoom
y0014984 Mar 19, 2024
8c4d4ae
2024-03-22-a
y0014984 Mar 22, 2024
e8bba7a
moved images and videos in article related subfolders
y0014984 Mar 22, 2024
b496ac4
updated 'team' page
y0014984 Apr 1, 2024
683a1db
moved raw images and videos
y0014984 Apr 1, 2024
8c45394
added favicon
y0014984 Apr 1, 2024
4af9e1b
added robots.txt
y0014984 Apr 1, 2024
cf31ecf
moved 'ai-generated' folder
y0014984 Apr 1, 2024
121100f
reorganized some images (public folder and general)
y0014984 Apr 1, 2024
01a5d30
small fix
y0014984 Apr 1, 2024
50fe0de
modified changelog
y0014984 Apr 1, 2024
6298aa7
renamed 'explore' to 'overview'
y0014984 Apr 1, 2024
e27b797
changed discord roadmap description
y0014984 Apr 1, 2024
b5e92e3
fixed english typos
y0014984 Apr 1, 2024
0a8816d
added DE translation (WIP)
y0014984 Apr 1, 2024
bfcf5a1
added DE translation (WIP)
y0014984 Apr 2, 2024
ad662c6
added DE translation (WIP)
y0014984 Apr 2, 2024
20d92cc
added DE translation (WIP)
y0014984 Apr 2, 2024
28c5013
added DE translation
y0014984 Apr 3, 2024
9e45207
vitepress update v1.0.0 RC44 -> v1.0.2
y0014984 Apr 5, 2024
8ebd787
added lazy loading
y0014984 Apr 5, 2024
f7105a8
converted PNG to WEBP and GIF to WEBM
y0014984 Apr 5, 2024
239b6b5
added SVG exports
y0014984 Apr 5, 2024
35cad97
fixed missing image
y0014984 Apr 5, 2024
94c1f6e
added SVG crown symbol
y0014984 Apr 5, 2024
9bb6ea9
changed screenshots (WIP)
y0014984 Apr 5, 2024
5c2e370
changed screenshots (WIP)
y0014984 Apr 6, 2024
0330a7b
changed invite links format
y0014984 Apr 8, 2024
32caaae
changed description of guest event invitations
y0014984 Apr 8, 2024
0a2db93
added info about the mandatory event-community interlink
y0014984 Apr 8, 2024
a155412
removed PNG and GIF files
y0014984 Apr 8, 2024
c06b69e
changed screenshots and other stuff
y0014984 Apr 10, 2024
a2576e7
Create README.md
y0014984 Apr 10, 2024
9d22a44
Merge branch 'initial-docs' of https://github.com/arma-events/docs in…
y0014984 Apr 10, 2024
f404767
changed warning message
y0014984 Apr 11, 2024
3833c72
added overview link to index page
y0014984 Apr 11, 2024
e285bbd
changed dev dependency to vitepress 1.0.2
y0014984 Apr 11, 2024
1c06f95
fixed link
y0014984 Apr 11, 2024
1ab4b9f
fixed typo
y0014984 Apr 14, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
216 changes: 197 additions & 19 deletions .vitepress/config.mts
Original file line number Diff line number Diff line change
@@ -1,28 +1,206 @@
// cSpell: disable

import { defineConfig } from 'vitepress'

// https://vitepress.dev/reference/site-config
export default defineConfig({
title: "Arma Events Documentation",
description: "Arma Events Documentation",
title: "docs.arma.events",
description: "arma.events Documentation",
srcDir: './src', // all *.md files in a subfolder called 'src'
cleanUrls: true, // without extension like .html
lastUpdated: true,
head: [['link', { rel: 'icon', href: '/favicon.ico' }]],
markdown: {
image: {
lazyLoading: true
}
},
themeConfig: {
// https://vitepress.dev/reference/default-theme-config
nav: [
{ text: 'Home', link: '/' },
{ text: 'Examples', link: '/markdown-examples' }
],

sidebar: [
{
text: 'Examples',
items: [
{ text: 'Markdown Examples', link: '/markdown-examples' },
{ text: 'Runtime API Examples', link: '/api-examples' }
]
}
],

search: {
provider: 'local'
},
externalLinkIcon: true,
logo: "/ae-logo.svg",
footer: {
message: "This website is not affiliated or authorized by Bohemia Interactive a.s. Bohemia Interactive, ARMA, DAYZ and all associated logos and designs are trademarks or registered trademarks of Bohemia Interactive a.s.",
copyright: "Copyright © 2024-present arma.events",
},
socialLinks: [
{ icon: 'github', link: 'https://github.com/vuejs/vitepress' }
{ icon: 'youtube', link: 'https://www.youtube.com/@arma.events' },
{ icon: 'discord', link: 'https://discord.gg/b2aABzh8xJ' },
{ icon: 'x', link: 'https://x.com/arma_events' }
]
},
locales: {
en: {
label: 'English',
lang: 'en', // optional, will be added as `lang` attribute on `html` tag
link: '/en/', // default /en/ -- shows on navbar translations menu, can be external
themeConfig: {
search: {
provider: 'local',
options: {
locales: {
de: {
translations: {
button: {
buttonText: 'Search'
},
modal: {
noResultsText: 'No results for',
resetButtonTitle: 'Reset search',
displayDetails: 'Display detailed list',
footer: {
selectText: 'to select',
navigateText: 'to navigate',
closeText: 'to close'
}
}
}
}
}
}
},
darkModeSwitchTitle: 'Switch to dark theme',
lightModeSwitchTitle: 'Switch to light theme',
lastUpdated: {
text: 'Updated at',
formatOptions: {
dateStyle: 'full',
timeStyle: 'medium'
}
},
editLink: {
pattern: 'https://github.com/arma-events/docs/edit/main/src/:path',
text: 'Edit this page on GitHub'
},
docFooter: {
prev: 'Previous page',
next: 'Next page'
},
nav: [
{ text: 'FAQ', link: '/en/faq' },
{ text: 'Support', link: '/en/support' },
{ text: 'Feedback', link: '/en/feedback' },
{ text: 'Contribution', link: '/en/contribution' }
],
sidebar: [
{
text: 'Articles',
items: [
{ text: 'Overview', link: '/en/overview' },
{ text: 'Users', link: '/en/users' },
{ text: 'Communities', link: '/en/communities' },
{
text: 'Events',
link: '/en/events',
items: [
{ text: 'Markdown', link: '/en/markdown' },
{ text: 'Slotslist', link: '/en/slotlist' }
]
}
]
},
{
text: 'Other Stuff',
items: [
{ text: 'Team', link: '/en/team' },
{ text: 'FAQ', link: '/en/faq' },
{ text: 'Support', link: '/en/support' },
{ text: 'Feedback', link: '/en/feedback' },
{ text: 'Contribution', link: '/en/contribution' },
{ text: 'Roadmap', link: '/en/roadmap' },
{ text: 'Changelog', link: '/en/changelog' },
{ text: 'Tech Stack', link: '/en/tech-stack' }
]
}
]
}
},
de: {
label: 'Deutsch',
lang: 'de', // optional, will be added as `lang` attribute on `html` tag
link: '/de/', // default /de/ -- shows on navbar translations menu, can be external
themeConfig: {
search: {
provider: 'local',
options: {
locales: {
de: {
translations: {
button: {
buttonText: 'Suchen'
},
modal: {
noResultsText: 'Keine Ergebnisse für',
resetButtonTitle: 'Suche zurücksetzen',
displayDetails: 'Detaillierte Liste anzeigen',
footer: {
selectText: 'um auszuwählen',
navigateText: 'um zu navigieren',
closeText: 'zum schließen'
}
}
}
}
}
}
},
darkModeSwitchTitle: 'Wechsle zum Dark Theme',
lightModeSwitchTitle: 'Wechsle zum Light Theme',
lastUpdated: {
text: 'Aktualisiert am',
formatOptions: {
dateStyle: 'full',
timeStyle: 'medium'
}
},
editLink: {
pattern: 'https://github.com/arma-events/docs/edit/main/src/:path',
text: 'Bearbeite diese Seite auf GitHub'
},
docFooter: {
prev: 'vorherige Seite',
next: 'nächste Seite'
},
nav: [
{ text: 'FAQ', link: '/de/faq' },
{ text: 'Support', link: '/de/support' },
{ text: 'Feedback', link: '/de/feedback' },
{ text: 'Mitwirkung', link: '/de/contribution' }
],
sidebar: [
{
text: 'Artikel',
items: [
{ text: 'Überblick', link: '/de/overview' },
{ text: 'Benutzer', link: '/de/users' },
{ text: 'Communities', link: '/de/communities' },
{
text: 'Events',
link: '/de/events',
items: [
{ text: 'Markdown', link: '/de/markdown' },
{ text: 'Slotsliste', link: '/de/slotlist' }
y0014984 marked this conversation as resolved.
Show resolved Hide resolved
]
}
]
},
{
text: 'Anderes Zeug',
items: [
{ text: 'Team', link: '/de/team' },
{ text: 'FAQ', link: '/de/faq' },
{ text: 'Support', link: '/de/support' },
{ text: 'Feedback', link: '/de/feedback' },
{ text: 'Mitmachen', link: '/de/contribution' },
{ text: 'Roadmap', link: '/de/roadmap' },
{ text: 'Changelog', link: '/de/changelog' },
{ text: 'Tech Stack', link: '/de/tech-stack' }
]
}
]
}
}
}
})
7 changes: 7 additions & 0 deletions .vitepress/theme/index.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.medium-zoom-overlay {
z-index: 30;
}

.medium-zoom-image {
z-index: 31;
}
26 changes: 26 additions & 0 deletions .vitepress/theme/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
// .vitepress/theme/index.js
import DefaultTheme from 'vitepress/theme';
import { onMounted, watch, nextTick } from 'vue';
import { useRoute } from 'vitepress';
import mediumZoom from 'medium-zoom';

import './index.css';

export default {
...DefaultTheme,

setup() {
const route = useRoute();
const initZoom = () => {
//mediumZoom('[data-zoomable]', { background: 'var(--vp-c-bg)' }); // enable for images with tag ![](path/to/file.jpg){data-zoomable}
mediumZoom('.main img', { background: 'var(--vp-c-bg)' }); // enable for all images
};
onMounted(() => {
initZoom();
});
watch(
() => route.path,
() => nextTick(() => initZoom())
);
},
};
68 changes: 68 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
{
"cSpell.overrides": [
{
"filename": "**/de/**",
"language": "de"
}
],
"cSpell.language": "en",
"cSpell.words": [
"Admins",
"arma",
"Ausklappmenü",
"Autolinks",
"blockquotes",
"BLUFOR",
"Briefing",
"Briefings",
"CAUTION",
"Decurion",
"deep",
"Drag-And-Drop",
"Entwurfsstatus",
"Fireteam",
"Fireteams",
"freemium",
"Gameserver",
"Gelir",
"Handles",
"IMPORTANT",
"Independant",
"intendation",
"irgendwelches",
"Kindelemente",
"Kronensymbol",
"Lead",
"Missionsattribute",
"Missionsauswertung",
"Missionsdatum",
"Missionsersteller",
"Missionsrückmeldungen",
"Mods",
"Nice-To-Have",
"nomisum",
"Objectives",
"OPFOR",
"ORBAT",
"outline",
"Posts",
"Quality-Of-Life",
"Reforger",
"Scrollrad",
"Scrollrades",
"slotlist",
"Slotliste",
"Slotlisten",
"slotlists",
"Slotting",
"Squad",
"Steam",
"strikethrough",
"Syntax-Highlighting",
"Teaser",
"Themes",
"Überschrifts",
"Viable",
"Zade"
]
}
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
All Affinity Designer files, raw screenshots and raw video captures as well as ai generated stuff is archived in a shared Google Drive. Request access if necessary.

[https://drive.google.com/drive/folders/1_Bs-sDADpvT5sxmiwAwzgul-GPsujakS?usp=drive_link](https://drive.google.com/drive/folders/1_Bs-sDADpvT5sxmiwAwzgul-GPsujakS)
49 changes: 0 additions & 49 deletions api-examples.md

This file was deleted.

Loading