GitHub Mkdocs Template

A template for using mkdocs with GitHub actions to generate a static site.

To get an overview of how to use this template, check out the main page of the example docs site!

Install mkdoks

To test out your site locally, you will need to install mkdocs. You can install it with conda like so:

conda create -n mkdocs
conda activate mkdocs
conda install -c conda-forge mkdocs

Run a development server

Activate the conda environment, or however you want to install it, and run the following.

cd _docs_src/
mkdocs serve

License

To the extent possible under law, Ryan M. Moore has waived all copyright and related or neighboring rights to GitHub Mkdocs Template.

If for whatever reason, CC0 will not work for your project, you may use MIT or the Unlicense.