Skip to content

Welcome to Oliver's Handbook

For full documentation visit mkdocs.org.

Experiment and experience.

Provide inspiration and guidance without inhibiting creativity.

My own little handbook and notes to help me "remember" what I have learned and done.

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.