mirror of
https://github.com/MichaelCurrin/mkdocs-quickstart.git
synced 2026-05-18 07:16:02 +02:00
michaelcurrin
26 lines
983 B
Markdown
26 lines
983 B
Markdown
# MkDocs Quickstart
|
|
> A concise recipe for setting up a MkDocs docs site on Github Pages
|
|
|
|
[](https://github.com/MichaelCurrin/mkdocs-quickstart)
|
|
|
|
|
|
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](https://www.mkdocs.org/) tutorial.
|