Skip to content

WXY Resources

This is a proof of concept of un-servering some of our materials based on the on-boarding doc lovingly made by our colleagues.

  • The site navigation is to the left <^
  • You can search for things top right ^>

MKDocs Documentation

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.