This add-on provides an easy way to build and deploy your MkDocs documentation. By default it installs Material for MkDocs and other extensions as well.
Supported themes and extensions:
- mkdocs-material
- Pygments
- pymdown-extensions
To install this add-on, add the following repository to your 'Hass.io Add-on store':
https://gitlab.com/tjorim/hassio-addons
If you have trouble doing this, you can follow the official docs.
Next you should install the "MkDocs" add-on from the Hass.io Dashboard.
Using Samba or the SSH & Web Terminal add-on,
create the /mkdocs folder in /share and place your project in it.
To summarize, /share/mkdocs should contain your mkdocs.yml and docs/ folder.
share
├───mkdocs
│ │ mkdocs.yml
│ │
│ └───docs
│ index.md
└───̶c̶a̶d̶d̶y
̶C̶a̶d̶d̶y̶f̶i̶l̶e
...
When started, the add-on will build the documentation and save it to /share/mkdocs/site,
next a simple Python HTTP Web server will deploy it on port 8000.
By default it will serve the built files on port 8000. You can change this in the Network options of the add-on.
If you have an issue with this add-on or have a feature request, please file an issue. If you want to improve the code, fix something, or add extra functionality, feel free to create a merge request.