Skip to content

Documentation / Website

This documentation website is generated with MkDocs. See the MkDocs documentation for detailed information on writing and styling documentation.

File layout

mkdocs.yml          # the configuration file
docs/       # the documentation homepage
    ...             # other markdown pages, images and other files

Live previews

With Docker installed and Chef Habitat installed, you can work against a live-updating local version of the site in one command:


Publishing documentation

Changes pushed/merged into the master branch will be automatically deployed via GitHub Actions within a couple minutes.

Added features

Several additional features/extensions are enabled in the documentation site: