diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 8dc3dbed0..b33bd7934 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -1,4 +1,6 @@ -import { defineConfig } from 'vitepress' +import {defineConfig} from 'vitepress' + +const PATH_TECHNIK = '/technik/'; // https://vitepress.dev/reference/site-config export default defineConfig({ @@ -12,9 +14,18 @@ export default defineConfig({ { text: 'Home', link: '/' }, { text: 'About', link: '/about/' }, { text: 'Features', link: '/features/' }, - { text: 'Technik', link: '/technik/' } + { text: 'Technik', link: PATH_TECHNIK } ], + sidebar: { + [PATH_TECHNIK]: [ + { text: 'Tools & Frameworks', link: `${PATH_TECHNIK}` }, + { + text: 'Getting Started', link: `${PATH_TECHNIK}get_started/` + } + ] + }, + socialLinks: [ { icon: 'github', link: 'https://github.com/it-at-m/Wahllokalsystem/' } ] diff --git a/docs/src/technik/get_started/index.md b/docs/src/technik/get_started/index.md new file mode 100644 index 000000000..8bbb2bcf8 --- /dev/null +++ b/docs/src/technik/get_started/index.md @@ -0,0 +1,7 @@ +# Getting started + +## Formatter einrichten + +Im Projekte verwenden wir `checkstyle` und `spotless` um für einen möglichst einheitlichen Codestyle zu sorgen. +Dazu haben wir Regeln definiert. Diese Regeln und deren Hinterlegung in der jeweiligen IDE ist +[hier](https://github.com/it-at-m/itm-java-codeformat) beschrieben. \ No newline at end of file