mirrors/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2025-05-13 22:54:42 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: run lint:fix

Browse source 
Signed-off-by: Philip Molares <philip.molares@udo.edu>
This commit is contained in:
Philip Molares 2023-07-08 15:39:12 +02:00
parent 50d4959e0a
commit e8e72c5328
6 changed files with 26 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -5,7 +5,9 @@ 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
<!-- 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
@ -27,8 +29,10 @@ To build the documentation locally you need to perform the following steps:
The documentation is deployed with [mkdocs][mkdocs].
The repository [docs.HedgeDoc.org][docs.HedgeDoc.org] is used to deploy the actual website
<!-- 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
[docs.hedgedoc.org]: https://github.com/hedgedoc/docs.hedgedoc.org