https://github.com/jd-apprentice/mkdocs-template
Template to startup a documentation site with mkdocs
https://github.com/jd-apprentice/mkdocs-template
Last synced: 5 months ago
JSON representation
Template to startup a documentation site with mkdocs
- Host: GitHub
- URL: https://github.com/jd-apprentice/mkdocs-template
- Owner: jd-apprentice
- License: mit
- Created: 2024-12-06T00:50:59.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-06T02:39:01.000Z (about 1 year ago)
- Last Synced: 2025-07-03T14:14:33.807Z (7 months ago)
- Size: 1.25 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MKDocs Starter
Template to startup a documentation site with mkdocs
## Contains
- base setup
- [github-actions](https://github.com/peaceiris/actions-gh-pages/tree/v4/)
- [mkdocs-material](https://squidfunk.github.io/mkdocs-material/)
## Configuration
Change the `site_name` in `mkdocs.yml`
### Not using a custom domain
If you don't have a domain, remove the property the `cname` in `.github/workflows/ci.yml`
### Using a custom domain
Change the `cname` in `.github/workflows/ci.yml`
In case you are using a custom domain you must create the CNAME in your DNS resolver
You point the CNAME (the one we are using at .github/workflows/ci.yml) to your github.io page which is normally `.github.io`
### Enable GitHub Pages
After the first push, a branch with the name of `gh-pages` will be created, now we do the following
### Theme
If you don't want to use material theme, change the `theme` in `mkdocs.yml` and `.github/workflows/ci.yml`
You can read more about it [HERE](https://www.mkdocs.org/user-guide/choosing-your-theme/)
## Workflow
```shell
🌳 mkdocs-template/
┣ 📁 .github/
┃ ┗ 📁 workflows/
┃ ┗ 📄 ci.yml
┣ 📁 docs/ -- Create your docs here
┃ ┗ 📄 index.md
┣ 📄 LICENSE
┣ 📄 README.md
┗ 📄 mkdocs.yml
```