From 9a4668db4758bb05394e9edab9eca915aa661866 Mon Sep 17 00:00:00 2001 From: michaelcurrin Date: Tue, 19 May 2020 13:33:01 +0200 Subject: [PATCH] Update README.md --- README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/README.md b/README.md index 8b4e6f5..d7f631a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,35 @@ # MkDocs Quickstart > A concise recipe for setting up a MkDocs docs site on Github Pages + +[![Made with MkDocs](https://img.shields.io/badge/Made_with-MkDocs-blue.svg)](https://www.mkdocs.org/) +[![GitHub tag](https://img.shields.io/github/tag/MichaelCurrin/mkdocs-quickstart.svg)](https://GitHub.com/MichaelCurrin/mkdocs-quickstart/tags/) +[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/MichaelCurrin/mkdocs-quickstart/blob/master/LICENSE) + + +## Preview + +![sample](/sample.png) + + + +## Live site + +[![GH pages](https://img.shields.io/badge/Github_Pages-MkDocs_Quickstart-green.svg?style=for-the-badge)](https://michaelcurrin.github.io/mkdocs-quickstart/) + +This project has a site deployed to Github Pages. + +Purposes: + +- a live demo +- a beginner-friendly tutorial on how to setup, run, deploy and customize this MkDocs project. + + +## Template + +[![Use this template](https://img.shields.io/badge/Use_this_template-green.svg?style=for-the-badge)](https://github.com/MichaelCurrin/mkdocs-quickstart/generate) + + + +## License + +Released under [MIT](/LICENSE).