MkDocs Quickstart

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

Preview

Live site

This project has a site deployed to Github Pages.

Note: The deploy is currently manually triggered by a local command, however there are Issues open to setup CI/CI remote deploys with Netlify or Github Actions.

Purposes of the site:

• A live demo.
• Content for a beginner-friendly tutorial on how to setup, run, deploy and customize a MkDocs project like this one.

Use this template

This repo also doubles as a template to create a new project from. Click the button at the top.

Change the content and theme to suit your needs, based on the tutorial site or the MkDocs site.

Contributing

Fork this project.

Set up the project locally - follow the instructions on the live tutorial or in the TLDR page of the local docs.

Make any changes you want. Be sure to keep a copy of the original license in the repo. e.g. cp LICENSE LICENSE-source.

Create a Pull Request.

License

Released under MIT.