Skip to content

Website

The website is generated with Material for MkDocs from the contents of the assets/chezmoi.io/docs/ directory. It hosted by GitHub pages from the gh-pages branch.

Install Material for MkDocs and the required plugins with:

$ pip3 install mkdocs-material mkdocs-mermaid2-plugin mkdocs-redirects mkdocs-simple-hooks

Test the website locally by running:

$ cd assets/chezmoi.io
$ mkdocs serve

and visiting https://127.0.0.1:8000/.

Deploy the website with:

$ mkdocs gh-deploy
Back to top