mirror of
https://github.com/hedgedoc/hedgedoc.git
synced 2024-09-19 23:48:57 -04:00
38 lines
1.5 KiB
Markdown
38 lines
1.5 KiB
Markdown
# Documentation
|
|
|
|
Our documentation is build with [mkdocs][mkdocs].
|
|
|
|
## Writing
|
|
|
|
All documentation files are found in the `docs/content` directory of
|
|
<!-- markdownlint-disable proper-names -->
|
|
the [hedgedoc/hedgedoc repo](https://github.com/hedgedoc/hedgedoc). These files are just normal
|
|
<!-- markdownlint-enable proper-names -->
|
|
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:
|
|
|
|
1. Make sure you have python3 installed.
|
|
2. Go into the `docs` folder.
|
|
3. Install all the dependencies (E.g. with a [venv](https://docs.python.org/3/library/venv.html))
|
|
with `pip install -r requirements.txt`
|
|
4. Start the mkdocs dev server (`mkdocs serve`) or build the documentation (`mkdocs build`).
|
|
|
|
## Deployment
|
|
|
|
The documentation is deployed with [mkdocs][mkdocs].
|
|
|
|
<!-- markdownlint-disable proper-names -->
|
|
The repository [docs.hedgedoc.org][docs.hedgedoc.org] is used to deploy the actual website
|
|
<!-- markdownlint-enable proper-names -->
|
|
to github.io. Currently only the `master` branch is deployed as it contains the latest release.
|
|
|
|
[mkdocs]: https://www.mkdocs.org
|
|
[docs.hedgedoc.org]: https://github.com/hedgedoc/docs.hedgedoc.org
|