diff --git a/README.md b/README.md index 39f1bc983d9006197207390891d951eb50a7b291..c01a61d084d29536ad7907cc06384dbce2cc013c 100644 --- a/README.md +++ b/README.md @@ -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.