mirror of
https://github.com/MichaelCurrin/mkdocs-quickstart.git
synced 2026-05-01 02:52:37 +02:00
59 lines
2.1 KiB
Markdown
59 lines
2.1 KiB
Markdown
# MkDocs Quickstart
|
|
> A template, live demo and tutorial for how to setup a MkDocs docs site on Github Pages
|
|
|
|
|
|
[](https://www.mkdocs.org/)
|
|
[](https://GitHub.com/MichaelCurrin/mkdocs-quickstart/tags/)
|
|
[](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 -->
|
|
|
|
<div align="center">
|
|
|
|
[](https://michaelcurrin.github.io/mkdocs-quickstart/)
|
|
[](https://github.com/MichaelCurrin/mkdocs-quickstart/generate)
|
|
|
|
</div>
|
|
|
|
|
|
## Preview
|
|
|
|
|
|
|
|
|
|
## Live site
|
|
|
|
This project has a site deployed to Github Pages.
|
|
|
|
_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._
|
|
|
|
Purposes of the site:
|
|
|
|
- A live demo.
|
|
- Content for a beginner-friendly tutorial on how to setup, run, deploy and customize a MkDocs project like this one.
|
|
|
|
|
|
## Use this template
|
|
|
|
This repo also doubles as a template to create a new project from. Click the button at the top.
|
|
|
|
Change the content and theme to suit your needs, based on the tutorial site or the MkDocs site.
|
|
|
|
|
|
## Contributing
|
|
|
|
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/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.
|
|
|
|
|
|
## License
|
|
|
|
Released under [MIT](/LICENSE).
|