From 7b729ba7597ba2a416b79f3fa3e38275b3a99ce8 Mon Sep 17 00:00:00 2001 From: Michael Currin Date: Tue, 2 Jun 2020 22:37:29 +0200 Subject: [PATCH] docs: Update README.md --- README.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index d185375..c64d3b7 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,11 @@ +[![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) + ## Preview @@ -16,28 +21,28 @@ ## 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: +_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._ + +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. -_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._ +## Use this template -## Template +This repo also doubles as a template to create a new project from. Click the button at the top. -[![Use this template](https://img.shields.io/badge/Use_this_template-green.svg?style=for-the-badge)](https://github.com/MichaelCurrin/mkdocs-quickstart/generate) +Change the content and theme to suit your needs, based on the tutorial site or the MkDocs site. ## Contributing Fork this project. -Set up the project locally - follow the instructions on the live tutorial or in the [docs](/docs/) directory. The TLDR section is a good overview. +Set up the project locally - follow the instructions on the live tutorial or in the [TLDR](/docs/tutorial/tldr.md) page of the local docs. Make any changes you want. Be sure to keep a copy of the original license in the repo. e.g. `cp LICENSE LICENSE-source`.