mirror of
https://github.com/MichaelCurrin/mkdocs-quickstart.git
synced 2026-06-29 14:31:31 +02:00
michaelcurrin
15 lines
433 B
Markdown
15 lines
433 B
Markdown
# MkDocs Quickstart
|
|
> A concise recipe for setting up a MkDocs docs site on Github Pages
|
|
|
|
|
|
This is based on the [mkdocs.org](https://www.mkdocs.org/) tutorial.
|
|
|
|
## Features
|
|
|
|
- Quickstart tutorial
|
|
- Live demo on Github Pages
|
|
- Template repo
|
|
|
|
|
|
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.
|