mkdocs-quickstart/docs/tutorial.md

Tutorial

How to create a MkDocs site

This is a summary of the tutorial on mkdocs.org.

Basic structure

This is the simplest MkDocs site you can make, with a config at the root and a homepage in the docs directory (by default). Usually on master branch.

mkdocs.yml
docs/
    index.md

The steps below start with that and extend it to more pages.

Run mkdocs new . to create the starter site above and to make the steps below go quicker.

Setup site

1. Create docs pages.
   1. Create docs directory.
   2. Create index.md
   3. Create other pages (optional).
2. Setup config.
   1. Create mkdocs.yml at project root.
   2. Setup navbar there. e.g.

      nav:
      - Home: index.md
      - About: about.md
      

   3. Choose a theme.

      theme: readthedocs
      

3. Create a favicon (optional).
   • It will be picked up at this path: docs/img/favicon.ico.

Further configuration

See Configuration page on MkDocs site for options.