Skip to content
Snippets Groups Projects
Commit 4929e34d authored by Pavel Břoušek's avatar Pavel Břoušek
Browse files

Update README.md

parent 33d5dc98
No related branches found
No related tags found
No related merge requests found
Pipeline #261407 passed
......@@ -51,22 +51,26 @@ You can easily convert the Markdown files using various online and offline tools
### mkdocs
To create a simple website with the documentation, you can use [mkdocs](https://www.mkdocs.org/user-guide/deploying-your-docs/)
To create a simple website with the documentation, you can use [mkdocs](https://www.mkdocs.org/user-guide/deploying-your-docs/).
Run:
To prepare, install [Python 3](https://www.python.org/downloads/) and [pip](https://pip.pypa.io/en/stable/installation/) and run:
```
pip3 install -r requirements.txt
```
Then run a local live server:
```sh
mkdocs serve
```
to run a local live server or:
or build the site:
```sh
mkdocs build
```
to build the site.
You can [publish](https://www.mkdocs.org/user-guide/deploying-your-docs/) to GitHub Pages, Read the Docs or any web server.
You can also upload the result to GitLab Pages by using the [.gitlab-ci.yml](.gitlab-ci.yml) in this repository.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment