hedgedoc/docs/content/dev/documentation.md
Philip Molares d173ff11e5
Docs: Fix dev doc 'documentation'
Fix typos
Rewrite 'Deployment' paragraph. We currently don't and probably won't use Messor Structor.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-03-20 13:18:06 +01:00

30 lines
1.3 KiB
Markdown

# Documentation
Our documentation is build with [mkdocs][mkdocs].
## Writing
All documentation files are found in the `docs/content` directory of
the [hedgedoc/hedgedoc repo](https://github.com/hedgedoc/hedgedoc). These files are just normal markdown files with
nothing special about them.
The configuration for mkdocs lies in the `docs` folder in a file called `mkdocs.yml`. With that file the theme and menu - among others - can be configured.
**Please note:** Any new files need to be linked to by other files or put in the navigation, otherwise 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:
0. Make sure you have python3 installed.
1. Go into the `docs` folder.
2. Install all the dependencies (E.g. with a [venv](https://docs.python.org/3/library/venv.html))
with `pip install -r requirements.txt`
3. Start the mkdocs dev server (`mkdocs serve`) or build the documentation (`mkdocs build`).
## Deployment
The documentation is deployed with [mkdocs][mkdocs].
The repository [docs.hedgedoc.org](https://github.com/hedgedoc/docs.hedgedoc.org) is used to deploy the actual website to github.io. Currently only the `master` branch is deployed as it contains the latest release.
[mkdocs]: (https://www.mkdocs.org)