diff --git a/docs/help/contribute/030_DOCS.md b/docs/help/contribute/030_DOCS.md new file mode 100644 index 0000000000..12b9c428e7 --- /dev/null +++ b/docs/help/contribute/030_DOCS.md @@ -0,0 +1,24 @@ +--- +title: docs +--- + +# :simple-readthedocs: MkDocs-Material + +If you want to contribute to the docs, there is a easy way to verify the results +of your changes before commiting them. + +Just follow the steps in the [Pull-Requests](010_PULL_REQUEST.md) docs, there we +already +[create a venv and install the docs extras](010_PULL_REQUEST.md#install-in-editable-mode). +When installed it's as simple as: + +```sh +mkdocs serve +``` + +This will build the docs locally and serve them on your local host, even +auto-refresh is included, so you can just update a doc, save it and tab to the +browser, without the needs of restarting the `mkdocs serve`. + +More information about the "mkdocs flavored markdown syntax" can be found +[here](https://squidfunk.github.io/mkdocs-material/reference/).