mkdocs-quickstart/docs/index.md

MkDocs Quickstart

A concise recipe for setting up 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

• Tutorial
  • Covering installation, setting up and configuring project, running it locally and deploying it.
• Template repo
  • Click Use this Template on Github.
• Live demo
  • Hosted on Github Pages.

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.