iarv/mkdocs-quickstart
1
0
Fork 0
mirror of https://github.com/MichaelCurrin/mkdocs-quickstart.git synced 2026-03-28 17:42:47 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
michaelcurrin
2020-09-10 17:24:39 +02:00
committed by GitHub
parent 1743e1c99f
commit bf0b822e71
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -1,5 +1,5 @@
# MkDocs Quickstart
> A template, live demo and tutorial for how to setup a MkDocs docs site on Github Pages
> A template, live demo and tutorial for how to setup a MkDocs docs site on GitHub Pages
![CI status](https://github.com/MichaelCurrin/mkdocs-quickstart/workflows/Deploy%20docs/badge.svg)
[![Made with MkDocs](https://img.shields.io/badge/Made_with-MkDocs-blue)](https://www.mkdocs.org/)
@@ -7,8 +7,7 @@
[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](#license)
<!-- TODO When creating a new project copied from this, you can delete this README.md and start over -->
<!-- TODO When creating a new project copied from this template, you can delete this README.md and start over -->
## Preview
@@ -24,6 +23,8 @@
</div>
Why use MkDocs? Compared with Jekyll and Docsify, I found the MkDocs code is much lighter to setup and changing themes is much easier than Jekyll. Also you get the benefits SEO which Docsify doesn't have. And it includes a search bar using JS.
### View live demo site
This project has a site deployed to GitHub Pages.