Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Documentation Pipeline for Publishing to Github Pages. Build Status

tl;dr

This project uses the cookiecutter project generator to generate a fully functional hosted documentation pipeline for you. Follow these steps:

  1. Ensure you have docker and make installed.
    • If you are running on Windows, you can simply run the docker commands that are in the Makefile
  2. Run pip install cookiecutter mako mkdocs mkdocs-material
  3. Run cookiecutter https://github.com/UnlockedEdu/documentation-pipeline-generator.git
  4. Write docs!

Since is a hosted documentation project, visit here for the full documentation.