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.

Change into the website directory:

$ cd assets/chezmoi.io

Defaultvirutalenv (Recommended)

Install the website dependencies:

$ pip3 install --user -r requirements.txt

Create a virtualenv with:

$ python3 -m venv .venv

and activate it.

Install the website dependencies:

$ pip3 install -r requirements.txt

Test the website locally by running:

$ mkdocs serve

and visiting http://127.0.0.1:8000/.

Deploy the website with:

$ mkdocs gh-deploy