MkDocs Quickstart

A concise recipe for setting up a MkDocs docs site on Github Pages

Preview

Live site

This project has a site deployed to Github Pages.

Purposes:

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

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.

Template

Contributing

Fork this project.

Set up the project locally - follow the instructions on the live tutorial or in the docs directory. The TLDR section is a good overview.

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.