Documentation Template using Cookiecutter, MkDocs, and GitHub Template

Create a project documentation template using Cookiecutter, MkDocs, and GitHub Template.

alpha2phi
4 min readJul 17, 2022
Documentation Template using Cookiecutter, MkDocs, and GitHub Template

In this article, we will use Cookiecutter, MkDocs, GitHub Template, and GitHub Actions workflow to develop a project documentation template. This ensures a consistent documentation approach across different development teams.

Getting Started

Cookiecutter

Cookiecutter is a command-line utility that creates projects from cookiecutters (project templates), e.g. creating a Python package project from a Python package project template.

There are many Cookiecutter repositories and templates that are readily available. We can use those templates to kick-start projects quickly.

For example, cookiecutter-Django is a framework for jump-starting production-ready Django projects quickly.

Cookiecutter can be installed either using pip or conda.

python3 -m pip install --user cookiecutter

MkDocs

MkDocs is a fast, simple, and downright gorgeous static site generator that’s geared towards building project documentation.

--

--

alpha2phi
alpha2phi

Written by alpha2phi

Software engineer, Data Science and ML practitioner.

No responses yet