Skip to content

Commit

Permalink
Initial Docs v1.0 (#1)
Browse files Browse the repository at this point in the history
  • Loading branch information
y0014984 authored Apr 16, 2024
1 parent 6bb0d76 commit b705a45
Show file tree
Hide file tree
Showing 180 changed files with 5,119 additions and 481 deletions.
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: 'Slotliste', link: '/de/slotlist' }
]
}
]
},
{
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

0 comments on commit b705a45

Please sign in to comment.