Skip to content

Ways of Working

Platform Engineering - Best practices, standards, policies & procedures

About

This site is authored with MKDocs For full documentation visit mkdocs.org. Please see below for useful commands

In addition, this website makes use of the Material for MkDocs theme.

Commands

  • mkdocs new [dir-name] - Create a new project.
  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs -h - Print help message and exit.

Project layout

mkdocs.yml    # The MK Docs configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.