diff --git a/README.md b/README.md index cce32ab..d245141 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,19 @@ # MkDocs Quickstart > A template, live demo and tutorial for how to setup a MkDocs docs site on Github Pages -![Deploy docs](https://github.com/MichaelCurrin/mkdocs-quickstart/workflows/Deploy%20docs/badge.svg) -[![Made with MkDocs](https://img.shields.io/badge/Made_with-MkDocs-blue.svg)](https://www.mkdocs.org/) +![CI status](https://github.com/MichaelCurrin/mkdocs-quickstart/workflows/Deploy%20docs/badge.svg) [![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) +[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](#license) + +[![Made with MkDocs](https://img.shields.io/badge/Made_with-MkDocs-blue)](https://www.mkdocs.org/)
-[![GH pages](https://img.shields.io/badge/Github_Pages-MkDocs_Quickstart-green.svg?style=for-the-badge)](https://michaelcurrin.github.io/mkdocs-quickstart/) -[![Use this template](https://img.shields.io/badge/Use_this_template-green.svg?style=for-the-badge)](https://github.com/MichaelCurrin/mkdocs-quickstart/generate) +[![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)
@@ -22,19 +23,18 @@ ![Sample screenshot](/sample.png) -## Live site +## How to use this project -This project has a site deployed to Github Pages. +### View live demo site -_Note: The deploy is currently manually triggered by a local command, however there are Issues open to setup CI/CI remote deploys with Netlify or Github Actions._ +This project has a site deployed to GitHub Pages. Purposes of the site: - A live demo. - Content for a beginner-friendly tutorial on how to setup, run, deploy and customize a MkDocs project like this one. - -## Use this template +### Use this template This repo also doubles as a template to create a new project from. Click the button at the top.