diff --git a/README.md b/README.md index dd470f7..e1fd97a 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,7 @@ Submit an issue. Or submit a code change: 1. Fork this project. -2. Set up the project locally - follow the instructions on the live tutorial or in the [TLDR](/docs/docs/tutorial/tldr.md) page of the local docs. +2. Set up the project locally - follow the instructions on the live tutorial or in the [TL;DR](/docs/docs/tutorial/tldr.md) page of the local docs. 3. Make any changes you want. Be sure to keep a copy of the original license in the repo. - e.g. `cp LICENSE LICENSE-source` 4. Create a Pull Request. diff --git a/docs/docs/index.md b/docs/docs/index.md index 8fe0947..0354f40 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -17,7 +17,7 @@ Follow the tutorial to add an existing project or create a project from scratch. - Run it locally. - Deploy it. - **Add a copy of this project to your repos** - - [![Use this template](https://img.shields.io/badge/Use_this_template-2ea44f)](https://github.com/MichaelCurrin/mkdocs-quickstart/generate) + - [![Use this template](https://img.shields.io/badge/Use_this_template-2ea44f?logo=github)](https://github.com/MichaelCurrin/mkdocs-quickstart/generate) - **View the live demo** - This site is hosted on GitHub Pages. See if you like it. Other themes are available - see the tutorial. diff --git a/docs/docs/tutorial/installation.md b/docs/docs/tutorial/installation.md index c94ad16..29164ae 100644 --- a/docs/docs/tutorial/installation.md +++ b/docs/docs/tutorial/installation.md @@ -19,7 +19,11 @@ Choose or setup a MkDocs project. Follow the tutorial page to setup a project. -Or click _Use this template_ on this repo to create your own copy of the repo, then clone it. +Or click the button on this repo to create your own copy of the repo. + +[![Use this template](https://img.shields.io/badge/Use_this_template-2ea44f?style=for-the-badge&logo=github)](https://github.com/MichaelCurrin/mkdocs-quickstart/generate) + +Then clone it. e.g. diff --git a/docs/docs/tutorial/tldr.md b/docs/docs/tutorial/tldr.md index 9b58e4d..3a9cb29 100644 --- a/docs/docs/tutorial/tldr.md +++ b/docs/docs/tutorial/tldr.md @@ -7,10 +7,10 @@ 1. [Install](installation.md) - `pip install mkdocs` 2. [Setup project](setup-project.md) - - `mkdocs new .` or [![Use this template](https://img.shields.io/badge/Use_this_template-green.svg)](https://github.com/MichaelCurrin/mkdocs-quickstart/generate) + - `mkdocs new .` or [![Use this template](https://img.shields.io/badge/Use_this_template-2ea44f&logo=github)](https://github.com/MichaelCurrin/mkdocs-quickstart/generate) 3. [Run](usage.md) - `mkdocs serve` -4. View on [http://localhost:8000](http://localhost:8000) +4. View on [localhost:8000](http://localhost:8000) ## Deploy to remote site