Skip to content

Commit 566de0e

Browse files
committed
docs: Update docs
1 parent 8bd56b6 commit 566de0e

File tree

4 files changed

+9
-5
lines changed

4 files changed

+9
-5
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Submit an issue.
7676
Or submit a code change:
7777

7878
1. Fork this project.
79-
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.
79+
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.
8080
3. Make any changes you want. Be sure to keep a copy of the original license in the repo.
8181
- e.g. `cp LICENSE LICENSE-source`
8282
4. Create a Pull Request.

docs/docs/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Follow the tutorial to add an existing project or create a project from scratch.
1717
- Run it locally.
1818
- Deploy it.
1919
- **Add a copy of this project to your repos**
20-
- [![Use this template](https://img.shields.io/badge/Use_this_template-2ea44f)](https://github.com/MichaelCurrin/mkdocs-quickstart/generate)
20+
- [![Use this template](https://img.shields.io/badge/Use_this_template-2ea44f?logo=github)](https://github.com/MichaelCurrin/mkdocs-quickstart/generate)
2121
- **View the live demo**
2222
- This site is hosted on GitHub Pages. See if you like it. Other themes are available - see the tutorial.
2323

docs/docs/tutorial/installation.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,11 @@ Choose or setup a MkDocs project.
1919

2020
Follow the tutorial page to setup a project.
2121

22-
Or click _Use this template_ on this repo to create your own copy of the repo, then clone it.
22+
Or click the button on this repo to create your own copy of the repo.
23+
24+
[![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)
25+
26+
Then clone it.
2327

2428
e.g.
2529

docs/docs/tutorial/tldr.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@
77
1. [Install](installation.md)
88
- `pip install mkdocs`
99
2. [Setup project](setup-project.md)
10-
- `mkdocs new .` or [![Use this template](https://img.shields.io/badge/Use_this_template-green.svg)](https://github.com/MichaelCurrin/mkdocs-quickstart/generate)
10+
- `mkdocs new .` or [![Use this template](https://img.shields.io/badge/Use_this_template-2ea44f&logo=github)](https://github.com/MichaelCurrin/mkdocs-quickstart/generate)
1111
3. [Run](usage.md)
1212
- `mkdocs serve`
13-
4. View on [http://localhost:8000](http://localhost:8000)
13+
4. View on [localhost:8000](http://localhost:8000)
1414

1515

1616
## Deploy to remote site

0 commit comments

Comments
 (0)