From eaeb88401d07687eb3db8c273f7a4c0ed31ec153 Mon Sep 17 00:00:00 2001 From: Tilman Vatteroth Date: Mon, 4 Jan 2021 13:07:44 +0100 Subject: Move docs into subdirectory to make mkdocs work in a subdirectory Signed-off-by: Tilman Vatteroth --- docs/dev/documentation.md | 27 --------------------------- 1 file changed, 27 deletions(-) delete mode 100644 docs/dev/documentation.md (limited to 'docs/dev/documentation.md') diff --git a/docs/dev/documentation.md b/docs/dev/documentation.md deleted file mode 100644 index aa3c5253..00000000 --- a/docs/dev/documentation.md +++ /dev/null @@ -1,27 +0,0 @@ -# Documentation - -Our documentation is build with [mkdocs](https://www.mkdocs.org). - -## Writing - -All documentation files are found in the `docs` directory of the [hedgedoc/hedgedoc repo](https://github.com/hedgedoc/hedgedoc). These files are just normal markdown files with nothing special about them. - -The config file for mkdocs lies in the root of the repo in a file called `mkdocs.yml`. With that file the theme and menu - amoung others - can be configured. -**Please note:** Any new files need to be linked to by other files or put in the navigation or the files will be very hard to find on the documentation website. - -## Building - -To build the documentation locally you need to perform the following steps: - -1. make sure you have python3 installed -2. install all the dependencies possibly with a [venv](https://docs.python.org/3/library/venv.html): -`pip install -r mkdocs.requirements.txt` -3. start the mkdocs dev server `mkdocs serve` or let it build the documentation `mkdocs build` - -## Deployment - -The documentation is deployed with [Messor Structor](https://github.com/traefik/structor). - -The necessary Dockerfile and version menu template and also the github action to build the whole documentation can be found in the [docs.hedgedoc.org repo](https://github.com/hedgedoc/docs.hedgedoc.org). This repo is also used to deploy the actuall website to github.io. - -Messor Structor builds and deploys the documentation by finding all branches that follow the pattern `v*` and build each one seperatly via `mkdocs` by first installing `mkdocs.requirements.txt` and then building. Afterwards the menu go template is used to include a version switcher in the theme and make all the different versions available. \ No newline at end of file -- cgit v1.2.3