github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-11-26 03:33:58 -05:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #1050 from hedgedoc/fix/devDocs

Browse source 
Docs: Fix dev doc 'documentation'
This commit is contained in:
David Mehren 2021-03-25 20:25:48 +01:00 committed by GitHub
commit 7775b0a288
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
docs/content/dev/documentation.md
View file

@ -1,6 +1,6 @@
# Documentation # Documentation
Our documentation is build with [mkdocs](https://www.mkdocs.org). Our documentation is build with [mkdocs][mkdocs].
## Writing ## Writing
@ -8,11 +8,8 @@ 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 the [hedgedoc/hedgedoc repo](https://github.com/hedgedoc/hedgedoc). These files are just normal markdown files with
nothing special about them. 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 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.
- 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 ## Building
@ -26,12 +23,8 @@ To build the documentation locally you need to perform the following steps:
## Deployment ## Deployment
The documentation is deployed with [Messor Structor](https://github.com/traefik/structor). The documentation is deployed with [mkdocs][mkdocs].
The necessary Dockerfile and version menu template and also the github action to build the whole documentation can be 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.
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*`. For each [mkdocs]: (https://www.mkdocs.org)
branch the docs are generated separately by first installing the dependencies from `requirements.txt` and then running
mkdocs. Afterwards the menu go template is used to include a version switcher in the theme.