mirror of
https://github.com/MichaelCurrin/mkdocs-quickstart.git
synced 2026-03-28 17:42:47 +01:00
88 lines
4.2 KiB
Markdown
88 lines
4.2 KiB
Markdown
# MkDocs Quickstart
|
|
> A template, live demo and tutorial for how to setup a MkDocs docs site on GitHub Pages
|
|
|
|
[](https://github.com/MichaelCurrin/mkdocs-quickstart/actions)
|
|
[](https://www.mkdocs.org/)
|
|
[](https://github.com/features/actions)
|
|
[](https://github.com/MichaelCurrin/mkdocs-quickstart/tags/)
|
|
[](#license)
|
|
|
|
|
|
<!-- TODO When creating a new project copied from this template, you can delete this README.md and start over -->
|
|
|
|
## Purpose
|
|
|
|
A low-code way to setup and host a markdown-based docs site with a professional look.
|
|
|
|
|
|
## Preview
|
|
|
|
[](https://michaelcurrin.github.io/mkdocs-quickstart/)
|
|
|
|
This project uses the _Read the Docs_ theme as seen above. It comes with MkDocs so you don't need to add to your dependencies. But you can switch to the MkDocs default or install and configure another theme.
|
|
|
|
|
|
## How to use this project
|
|
|
|
<div align="center">
|
|
|
|
[](https://michaelcurrin.github.io/mkdocs-quickstart/)
|
|
[](https://github.com/MichaelCurrin/mkdocs-quickstart/generate)
|
|
|
|
</div>
|
|
|
|
|
|
## Features
|
|
|
|
- A **markdown-based** docs site which is easy to edit - see the content in the [docs](/docs/docs/) directory.
|
|
- Easy to **configure** - see the short [mkdocs.yml](/docs/mkdocs.yml) file.
|
|
- Use the configured theme or switch to another - no need to write HTML and CSS yourself.
|
|
- Each theme comes with a navbar and you write YAML - Jekyll themes on GH Pages need you to write your own HTML often and each theme handles navbar its own way (sometimes not at all).
|
|
- Uses a deploy pipeline on GH Actions to deploy a GH Pages site - the action actually runs GH Pages deploy command.
|
|
- The static site output is **SEO-friendly**.
|
|
- Built on Python but you don't need to write any Python code.
|
|
|
|
### View live demo site
|
|
|
|
This project has a site deployed to GitHub Pages.
|
|
|
|
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.
|
|
|
|
To isolate the MkDocs flow from the rest of your code, you can put the configs and the `docs` folder of content inside the `docs` directory. That means you end up having `docs/docs`, which is okay. Just make sure you select the `/docs` directory when setting up GH Pages.
|
|
|
|
|
|
## Why use MkDocs?
|
|
|
|
If you're new to MkDocs, look at the tutorial added on this project's site, otherwise go to the MkDocs documentation.
|
|
|
|
This project provides a way to write your docs in markdown and build a professional-looking docs site on top of it, without having to write HTML or CSS code and using a selection of themes. While MkDocs CLI has functionality to deploy from a local command-line, this project makes deploying effortless by using GitHub Actions to build and deploy the site to a `gh-pages` branch and GitHub Pages to serve the site.
|
|
|
|
Compared with Jekyll and Docsify, I found the MkDocs code is much lighter to setup and changing themes is much easier than Jekyll. Also you get the benefits SEO which Docsify doesn't have. And it includes a search bar using JS.
|
|
|
|
|
|
## 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 [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.
|
|
|
|
|
|
## License
|
|
|
|
Released under [MIT](/LICENSE).
|