From 49b3a80578253c9552348e39dce887b95e898d76 Mon Sep 17 00:00:00 2001 From: michaelcurrin Date: Thu, 10 Sep 2020 17:35:30 +0200 Subject: [PATCH] Update README.md --- README.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index a8e3b58..9ac925c 100644 --- a/README.md +++ b/README.md @@ -13,23 +13,24 @@ [![Sample screenshot](/sample.png)](https://michaelcurrin.github.io/mkdocs-quickstart/) - -## Features - -- Markdown-based docs site which is easy to edit -- Easy to configure without having to write HTML and CSS -- Uses a deploy pipeline on GH Actions to deploy a GH Pages site - - ## How to use this project
-[![GH pages](https://img.shields.io/badge/Github_Pages-MkDocs_Quickstart-green?style=for-the-badge)](https://michaelcurrin.github.io/mkdocs-quickstart/) +[![GH Pages](https://img.shields.io/badge/Github_Pages-MkDocs_Quickstart-green?style=for-the-badge)](https://michaelcurrin.github.io/mkdocs-quickstart/) [![Use this template](https://img.shields.io/badge/Use_this_template-2ea44f?style=for-the-badge)](https://github.com/MichaelCurrin/mkdocs-quickstart/generate)
+ +## Features + +- A markdown-based docs site which is easy to edit - see the content [docs](/docs/) directory. +- Easy to configure - see the short [mkdocs.yml](/mkdocs.yml) file. +- Use the configured theme or switch to another - no need to write HTML and CSS. +- Uses a deploy pipeline on GH Actions to deploy a GH Pages site. + + ### View live demo site This project has a site deployed to GitHub Pages.