diff --git a/README.md b/README.md index e2f046c..34aa815 100644 --- a/README.md +++ b/README.md @@ -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) - - + ## Preview @@ -24,6 +23,8 @@ +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.