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/
    README.md       # 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:

script/studio

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:

• Mermaid code fences
• Awesome Pages Plugin
• Material theme
  • Admonitions
  • CodeHilite
  • Metadata
  • Permalinks
  • PyMdown Markdown Extensions
    • InlineHilite
    • Tasklist
    • SmartSymbols
    • SuperFences