mirror of
https://github.com/MichaelCurrin/mkdocs-quickstart.git
synced 2026-08-08 01:43:04 +02:00
Update README.md
This commit is contained in:
@@ -9,15 +9,17 @@
|
|||||||
|
|
||||||
<!-- TODO When creating a new project copied from this, you can delete this README.md and start over -->
|
<!-- TODO When creating a new project copied from this, you can delete this README.md and start over -->
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
|
||||||
[](https://michaelcurrin.github.io/mkdocs-quickstart/)
|
[](https://michaelcurrin.github.io/mkdocs-quickstart/)
|
||||||
|
|
||||||
|
|
||||||
[](https://github.com/MichaelCurrin/mkdocs-quickstart/generate)
|
[](https://github.com/MichaelCurrin/mkdocs-quickstart/generate)
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
## Preview
|
## Preview
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
|
||||||
## Live site
|
## Live site
|
||||||
@@ -41,13 +43,14 @@ Change the content and theme to suit your needs, based on the tutorial site or t
|
|||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
Fork this project.
|
Submit an issue.
|
||||||
|
|
||||||
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.
|
Or submit a code change:
|
||||||
|
|
||||||
Make any changes you want. Be sure to keep a copy of the original license in the repo. e.g. `cp LICENSE LICENSE-source`.
|
1. Fork this project.
|
||||||
|
2. 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.
|
||||||
Create a Pull Request.
|
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.
|
||||||
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|||||||
Reference in New Issue
Block a user