Skip to content

Welcome to the TWE Design System Template

CREATING YOUR SITE

pip install mkdocs-material

CONFIGURATION

site_name: <insert org name>
nav:
  - Home: index.md
  - About: about.md
theme: markdown

For full documentation visit mkdocs.org.

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 configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.