Cookiecutter Template for Project Documentation

A project documentation template.

Usage - Option 1

1. Install cookiecutter

$ pip install cookiecutter

2. Create new project from Cookiecutter by calling

$ cookiecutter https://github.com/alpha2phi/doc-template.git

3. Install Python packages

$ pip install -r requirements.txt

4. Run mkdocs

$ mkdocs serve

Usage - Option 2

Create a repository from this template

1. Click the big green button Use this template or click here.
2. Enter a Repository name and click Create repository from template
3. Head over to the created repository and complete the setup.

Complete setup

1. In the a new repository, complete the project setup by editing the cookiecutter.json file.
2. Perform a commit (the commit message doesn't matter).
3. Wait Setup Repository Action to complete.