refactor: migrate to docusaurus

README.md

@@ -1,34 +1,41 @@
-# @lfk/documentation
-
-The documentation for the LfK! 'Läufersystem'.
-Powered by Vuepress.
-
-The main language for the content is German (since our primary target audience is the Lauf für Kaya! Team at a local German school).
-
-## Quickstart 🐳
-> Use this to run the documentation server via docker.
-
-1. Clone the repo or copy the docker-compose.yml
-2. Cd into the folder containing the docker-compose.yml
-2. Run docker-compose: `docker-compose up -d`
-3. Visit http://127.0.0.1:8080/ to check if the server is running
-
-## Dev Setup 🛠
-> Local dev setup for previewing changes.
-
-1. Install Dependencies
-   ```bash
-   yarn
-   ```
-2. Start the server
-   ```bash
-   yarn dev
-   ```
-
-## Recommended Editor
-
-[Visual Studio Code](https://code.visualstudio.com/)
-
-### Recommended Extensions
-
-* will be automatically recommended via ./vscode/extensions.json
+# Website
+
+This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.