diff options
| -rw-r--r-- | .gitignore | 2 | ||||
| -rw-r--r-- | docs/dev/documentation.md | 27 | ||||
| -rw-r--r-- | docs/dev/getting-started.md | 2 | ||||
| -rw-r--r-- | mkdocs.yml | 3 |
4 files changed, 32 insertions, 2 deletions
@@ -26,3 +26,5 @@ public/views/build public/uploads/* !public/uploads/.gitkeep + +site/ diff --git a/docs/dev/documentation.md b/docs/dev/documentation.md new file mode 100644 index 00000000..aa3c5253 --- /dev/null +++ b/docs/dev/documentation.md @@ -0,0 +1,27 @@ +# 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 diff --git a/docs/dev/getting-started.md b/docs/dev/getting-started.md index b0623926..b7787117 100644 --- a/docs/dev/getting-started.md +++ b/docs/dev/getting-started.md @@ -1,4 +1,4 @@ -# Developer Notes +# Getting started ## Preparing for running the code @@ -33,10 +33,11 @@ nav: - Setting Terms: guides/providing-terms.md - Configuration: configuration.md - Developer: + - 'Getting Started': dev/getting-started.md - API: dev/api.md - - 'Developer Notes': dev/getting-started.md - 'Operational Transformation': dev/ot.md - Webpack: dev/webpack.md + - 'Documentation': dev/documentation.md - FAQ: https://hedgedoc.org/faq markdown_extensions: - toc: |