diff --git a/README.md b/README.md index c4276d5..d185375 100644 --- a/README.md +++ b/README.md @@ -6,12 +6,14 @@ [![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/) @@ -20,16 +22,27 @@ This project has a site deployed to Github Pages. Purposes: -- A live demo +- 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._ + ## 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) +## 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. + +Make any changes you want. Be sure to keep a copy of the original license in the repo. e.g. `cp LICENSE LICENSE-source`. + +Create a Pull Request. + ## License