iarv/mkdocs-quickstart
1
0
Fork 0
mirror of https://github.com/MichaelCurrin/mkdocs-quickstart.git synced 2026-05-08 14:24:54 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update index.md

Browse Source
This commit is contained in:
michaelcurrin
2020-05-03 09:24:15 +02:00
committed by GitHub
parent d59ed88866
commit cfb5853123
1 changed files with 14 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/index.md
+14 -1
View File
@@ -4,7 +4,7 @@
This is based on the [mkdocs.org](https://www.mkdocs.org/) tutorial.
## Features
## Features of this project
- Quickstart tutorial
- Live demo on Github Pages
@@ -12,3 +12,16 @@ This is based on the [mkdocs.org](https://www.mkdocs.org/) tutorial.
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.
## Reasons to use MdDocs
- Create an elegant, modern docs site for your project.
- Create a static site and serve from Github Pages easily.
- Flexible theming.
- No coding in HTML or templating langauge needed - use your existing markdown files and a YAML config.
- Customizable.
- Plugins available.
- Includes search by default.
MkDocs is built in Python (like Sphynx) but you don't have to write Python code. If you setup a [Deploy](deloy) flow right, you don't even have to set it up locally, though then you can't preview.