github-docs-cookiecutter

Author: Jared Cook
Version: 0.1.1

Overview

Github docs cookiecutter template generation.

Template cookiecutter project for Github Pages (Jekyll). This project can utilize a variety of different documentation templates but is focused mainly on a clean implementation of just the docs. Skip the boring boilerplate code and get to the work that matters.

---

Utilizes:
The github-docs-cookiecutter depends on the following repositories for its documentation and sub-features.

• cookiecutter-cookiecutter Generates cookiecutter template projects and is able to be queried by generated projects for autogenerated file updates.
• Github docs via the cookiecutter-cookiecutter this project is used as a sub-template to generate documentation.
• Nutri-Matic cookiecutter hooks and tools for documentation build. The nutrimatic package has become a .

Maintains:
The github-docs-cookiecutter is used to maintain documentation for the following projects.

Cookiecutter Projects:

• cookiecutter-cookiecutter
• python3-cookiecutter
• ansible-galaxy-cookiecutter

Python Projects:

• Nutri-Matic

Ansible Projects:

• jcook3701.docker Ansible Galaxy collection used to install docker packages.
• jcook3701.flatpak Ansible Galaxy collection used to install flatpak packages.
• jcook3701.pkgs Ansible Galaxy collection used to install system (Debian, Ubuntu, RHEL) packages.
• jcook3701.source Ansible Galaxy collection used to install packages from source code.
• jcook3701.snap Ansible Galaxy collection used to install snap packages.

---

🛠️ CI/CD Check List:

• 
• 
• 
• 
• 
• 
• 

---

Usage Examples

Example: Pull from main branch.

1. Pull Project with cookiecutter command:

   $ cookiecutter [email protected]:jcook3701/github-docs-cookiecutter.git  
   

   Example: Pull from develop branch.

2. Pull code from development branch while testing updates.

   $ cookiecutter [email protected]:jcook3701/github-docs-cookiecutter.git --checkout develop  
   

Advance Examples

Note: The real intention of this project is to call it as a hook within other cookiecutter projects as shown below.
Explanation: ansible-galaxy-cookiecutter template utilizes nutri-matic hooks to pull both this documentation template along with sphinx-cookiecutter template into generated project $(PROJECT_ROOT)/docs/.

Utilization of nutri-matic is the optimal way of integrating this template in projects.

---

🌱 Getting Started

• Requirements
• Installation guide

📚 Documentation

The github-docs-cookiecutter documentation is available at docs.

🤝 Contributing

If you’re interested in contributing to the github-docs-cookiecutter project:

• Start by reading the contributing guide.
• Learn how to setup your local environment, in our developer guide.
• Look through our style guide.

---

🍹 Authors Notes

1. This code currently works with cookiecutter (2.6) from PyPi repositories.

⚖️ License

Copyright (c) 2025-2026, Jared Cook

This project is licensed under the AGPL-3.0-or-later License.
See the LICENSE file for the full license text.

SPDX-License-Identifier: AGPL-3.0-or-later