mkdocs-quickstart/docs/index.md

MkDocs Quickstart

A template, live demo and tutorial for how to setup a MkDocs docs site on Github Pages

Use the MkDocs (make docs) tool to create build a docs site around markdown docs.

Follow the tutorial to add an existing project or create a project from scratch. The result will look like this project.

Features

How to use this project

• Follow the tutorial instructions
  • Install and configure a new or existing project.
  • Run it locally.
  • Deploy it.
• Add a copy of this project to your repos
  • 
• View the live demo
  • This site is hosted on Github Pages. See if you like it. Other themes are available - see the tutorial.

The aim here is not be complete or explain all concepts. It is to provide a reference for common steps and choices needed when setting up a docs site, but still at a beginner-friendly level.

This guide is based on the mkdocs.org tutorial.