mirror of
https://github.com/MichaelCurrin/mkdocs-quickstart.git
synced 2026-05-05 04:52:37 +02:00
docs: Update README.md
This commit is contained in:
17
README.md
17
README.md
@@ -6,12 +6,14 @@
|
||||
[](https://github.com/MichaelCurrin/mkdocs-quickstart/blob/master/LICENSE)
|
||||
|
||||
|
||||
<!-- TODO When creating a new project copied from this, you can delete this README.md and start over -->
|
||||
|
||||
|
||||
## Preview
|
||||
|
||||

|
||||
|
||||
|
||||
|
||||
## Live site
|
||||
|
||||
[](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
|
||||
|
||||
[](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
|
||||
|
||||
|
||||
Reference in New Issue
Block a user