Welcome to MkDocs

For full documentation visit mkdocs.org.

Requirements:

You must install mkdocs to build the documentation. pip install mkdocs

Build

When you have mkdocs installed, build.sh will invoke mkdocs to build the project documentation as part of the gh-pages.

Other Commands

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

Project layout

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

« Previous