GitHub - zwbetz-gh/mkdocs-template: The no-excuses template to document your project

MkDocs Template

The no-excuses template to document your project. Powered by MkDocs, Material for MkDocs, and GitHub Pages.

View Published Docs

https://zwbetz-gh.github.io/mkdocs-template/

One-Time Setup

1. Fork or download a zip of this repo

2. Install python3 (which should include pip3)

3. Install requirements

    pip3 install -r requirements.txt
   

4. Fill out the mkdocs.yml file with your info

Make Your Docs

1. Make your documentation changes

2. Preview your changes at http://127.0.0.1:8000

    mkdocs serve
   

3. Deploy your changes to GitHub Pages

    mkdocs gh-deploy