Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 0 additions & 20 deletions .github/PULL_REQUEST_TEMPLATE/02-bug_fix.md

This file was deleted.

21 changes: 0 additions & 21 deletions .github/PULL_REQUEST_TEMPLATE/03-feature_request.md

This file was deleted.

1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@

<p><a href="LICENSE"><img src="https://img.shields.io/github/license/jcook3701/github-docs-cookiecutter" alt="License" /></a></p>

<!-- [![CLA assistant](https://github.com/jcook3701/github-docs-cookiecutter/actions/workflows/cla.yml/badge.svg)]() -->
<p><img src="https://github.com/jcook3701/github-docs-cookiecutter/actions/workflows/dependency-check.yml/badge.svg" alt="dependency-check" />
<img src="https://github.com/jcook3701/github-docs-cookiecutter/actions/workflows/format-check.yml/badge.svg" alt="format-check" />
<img src="https://github.com/jcook3701/github-docs-cookiecutter/actions/workflows/lint-check.yml/badge.svg" alt="lint-check" />
Expand Down
35 changes: 28 additions & 7 deletions changelogs/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,17 +154,38 @@ Feat 014 (#43)
- Merge pull request #46 from jcook3701/develop

Feat 015 (#45)
- Feat 016 (#47)

* fix(docs): Docs are not being updated with upgrade for some reason. debugging.

* fix(docs): Revert. Docs are not being updated with upgrade for some reason. debugging.

* fix(template): figured out _is_sub_template needs to be false for the documents. Need to fix the cookiecutter-cookiecutter hooks.

* fix(configuration): cookiecutter upgrader configuration fix.

* fix(template): Forgot to add configuration setting to main settings file.

* fix(template): Forgot to add configuration setting to main settings file.

* fix(theme): Update to latest just the docs theme.

* fix(template): minor fix.
- Merge pull request #48 from jcook3701/develop

Feat 016 (#47)

### 🐛 Fixed

- *(template)* Updates to template cookiecutter.json file.
- *(docs)* Docs are not being updated with upgrade for some reason. debugging.
- *(docs)* Revert. Docs are not being updated with upgrade for some reason. debugging.
- *(template)* Figured out _is_sub_template needs to be false for the documents. Need to fix the cookiecutter-cookiecutter hooks.
- *(configuration)* Cookiecutter upgrader configuration fix.
- *(template)* Forgot to add configuration setting to main settings file.
- *(template)* Forgot to add configuration setting to main settings file.
- *(theme)* Update to latest just the docs theme.
- *(configuration)* I think this should fix the last of the problems with main showing up where master should for this repository.
- *(links)* Major fixes for documentation links.
- *(docs)* Fixed license image shield.

### 🚀 Added

- *(docs)* Updates to setup, getting-started, and initial tutorials.
- *(faq)* Added the Frequently asked questions page.
## [0.1.0] - 2025-12-05

### ⚙️ Miscellaneous
Expand Down
37 changes: 29 additions & 8 deletions changelogs/releases/v0.1.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# Changelog:
# --------------------------------------------------

## [0.1.1] - 2026-01-27
## [0.1.1] - 2026-01-29

### ⚙️ Miscellaneous

Expand Down Expand Up @@ -154,14 +154,35 @@ Feat 014 (#43)
- Merge pull request #46 from jcook3701/develop

Feat 015 (#45)
- Feat 016 (#47)

* fix(docs): Docs are not being updated with upgrade for some reason. debugging.

* fix(docs): Revert. Docs are not being updated with upgrade for some reason. debugging.

* fix(template): figured out _is_sub_template needs to be false for the documents. Need to fix the cookiecutter-cookiecutter hooks.

* fix(configuration): cookiecutter upgrader configuration fix.

* fix(template): Forgot to add configuration setting to main settings file.

* fix(template): Forgot to add configuration setting to main settings file.

* fix(theme): Update to latest just the docs theme.

* fix(template): minor fix.
- Merge pull request #48 from jcook3701/develop

Feat 016 (#47)

### 🐛 Fixed

- *(template)* Updates to template cookiecutter.json file.
- *(docs)* Docs are not being updated with upgrade for some reason. debugging.
- *(docs)* Revert. Docs are not being updated with upgrade for some reason. debugging.
- *(template)* Figured out _is_sub_template needs to be false for the documents. Need to fix the cookiecutter-cookiecutter hooks.
- *(configuration)* Cookiecutter upgrader configuration fix.
- *(template)* Forgot to add configuration setting to main settings file.
- *(template)* Forgot to add configuration setting to main settings file.
- *(theme)* Update to latest just the docs theme.
- *(configuration)* I think this should fix the last of the problems with main showing up where master should for this repository.
- *(links)* Major fixes for documentation links.
- *(docs)* Fixed license image shield.

### 🚀 Added

- *(docs)* Updates to setup, getting-started, and initial tutorials.
- *(faq)* Added the Frequently asked questions page.
4 changes: 2 additions & 2 deletions cookiecutter.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@
"America/Los_Angeles"
],
"license": [
"MIT",
"AGPL-3.0-or-later",
"AGPL-3.0-only",
"Apache-2.0",
"GPL-3.0-or-later",
"GPL-3.0-only",
"Apache-2.0",
"BSD-3-Clause",
"BSD-2-Clause",
"0BSD",
"MIT",
"Unlicense"
],
"contribution_model": [
Expand Down
2 changes: 1 addition & 1 deletion docs/cookiecutter_input.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"__year_range": "2025-2026",
"_checkout": "main",
"_copy_without_render": [],
"_default_branch": "main",
"_default_branch": "master",
"_extensions": [
"jinja2.ext.do",
"jinja2.ext.loopcontrols"
Expand Down
5 changes: 5 additions & 0 deletions docs/jekyll/Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ GEM
addressable (2.8.7)
public_suffix (>= 2.0.2, < 7.0)
base64 (0.3.0)
bigdecimal (4.0.1)
colorator (1.1.0)
concurrent-ruby (1.3.6)
csv (3.3.5)
Expand Down Expand Up @@ -112,6 +113,9 @@ PLATFORMS
x86_64-linux

DEPENDENCIES
base64
bigdecimal
csv
faraday (~> 2.14)
faraday-retry (~> 2.3)
jekyll (~> 4.4)
Expand All @@ -122,6 +126,7 @@ DEPENDENCIES
jekyll-seo-tag
jekyll-sitemap
just-the-docs (~> 0.11)
logger

BUNDLED WITH
2.5.23
1 change: 1 addition & 0 deletions docs/jekyll/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Template cookiecutter project for Github Pages (Jekyll). This project can utili

[![License](https://img.shields.io/github/license/jcook3701/github-docs-cookiecutter)](LICENSE)

<!-- [![CLA assistant](https://github.com/jcook3701/github-docs-cookiecutter/actions/workflows/cla.yml/badge.svg)]() -->
![dependency-check](https://github.com/jcook3701/github-docs-cookiecutter/actions/workflows/dependency-check.yml/badge.svg)
![format-check](https://github.com/jcook3701/github-docs-cookiecutter/actions/workflows/format-check.yml/badge.svg)
![lint-check](https://github.com/jcook3701/github-docs-cookiecutter/actions/workflows/lint-check.yml/badge.svg)
Expand Down
2 changes: 1 addition & 1 deletion {{ cookiecutter.project_slug }}/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ PUBLISHDIR ?=
# 📚 Documentation (Sphinx + Jekyll)
# --------------------------------------------------
RUBY_INSTALL := bundle install
JEKYLL_BUILD := bundle exec jekyll build --quiet
JEKYLL_BUILD := bundle exec jekyll build --trace --verbose
JEKYLL_CLEAN := bundle exec jekyll clean
JEKYLL_SERVE := bundle exec jekyll serve
# --------------------------------------------------
Expand Down
25 changes: 13 additions & 12 deletions {{ cookiecutter.project_slug }}/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# {{ site.title }}

[![License](https://img.shields.io/github/license/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }})](LICENSE.md)
[![License](https://img.shields.io/github/license/{{ site.github_username }}{{ site.baseurl }})](LICENSE)

__Author:__ {{ site.author }}
__Version:__ {{ site.version }}
Expand All @@ -18,24 +18,25 @@ __CI/CD Check List:__
* ![typecheck]({{ site.repo_url }}/actions/workflows/typecheck.yml/badge.svg)

***
<!-- NOTE: This page is currently included in _copy_without_render which is why there are no raw or endraw tags. And no calls to {{ cookiecutter.etc }}. -->
<!-- NOTE: On this page all links need to be from site.github_io_url and not jinja2 links -->

## Getting Started
* [Get {{ cookiecutter.project_name}}]
* [Installation guides]
* [Installation guide]({{ site.github_io_url }}/manual/introduction/installation-guide)

## Documentation
The {{ cookiecutter.project_name }} documentation is available at [docs]({{ site.github_io_url }})
The {{ site.title }} documentation is available at [docs]({{ site.github_io_url }}).

## Contributing
If you're interested in contributing to the {{ cookiecutter.project_name }} project:
* Start by reading the [contributing guide]({{ site.github_io_url }}/developer-resources/contribute.md).
* Learn how to setup your local environment, in our [developer guide]({{ site.github_io_url }}/contribute/developer-guide.md).
* Look through our [style guide]({{ site.github_io_url }}/contribute/style-guides/index.md).
If you're interested in contributing to the {{ site.title }} project:
* Start by reading the [contributing guide]({{ site.github_io_url }}/developer-resources/contribute).
* Learn how to setup your local environment, in our [developer guide]({{ site.github_io_url }}/contribute/developer-guide).
* Look through our [style guide]({{ site.github_io_url }}/contribute/style-guides/index).

## License
{{ cookiecutter.copyright }}
{{ site.copyright }}

This project is licensed under the __{{ cookiecutter.license }} License__.
See the [LICENSE]({{ site.repo_blob }}/LICENSE.md) file for the full license text.
This project is licensed under the __{{ site.license }} License__.
See the [LICENSE]({{ site.repo_blob }}/LICENSE.md) file for the full license text.

SPDX-License-Identifier: {{ cookiecutter.license }}
SPDX-License-Identifier: {{ site.license }}
2 changes: 2 additions & 0 deletions {{ cookiecutter.project_slug }}/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
title: "{{ cookiecutter.project_name }}"
author: "{{ cookiecutter.author }}"
version: "{{ cookiecutter.version }}"
license: "{{ cookiecutter.license }}"
copyright: "{{ cookiecutter.copyright }}"
timezone: "{{ cookiecutter.timezone }}"
description: "{{ cookiecutter.description }}"
remote_theme: "{{ cookiecutter.theme }}"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ We're excited to hear your ideas! Before you submit a feature request, consider

## Your first feature request

When you're ready to submit a feature request, use the [feature request template]({{ cookiecutter.repo_url }}/issues/new?template=02-feature_request.md). The template has three sections that help maintainers understand what you need and why.
When you're ready to submit a feature request, use the [feature request template]({{ cookiecutter.repo_url }}/issues/new?template=02-feature-request.yml). The template has three sections that help maintainers understand what you need and why.

<!-- TODO: Put together an example feature request.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ Every contribution to {{ cookiecutter.project_name }}'s software begins with a [

We know you're excited to create your first pull request. Before we get started, read these resources first:

- Get started [contributing to {{ cookiecutter.project_name }}]({% raw %}{{ site.repo_url }}{% endraw %}/CONTRIBUTING.md).
- Get started [contributing to {{ cookiecutter.project_name }}]({% raw %}{{ site.repo_blob }}{% endraw %}/.github/CONTRIBUTING.md).
- Make sure your code follows the relevant [style guides]({% raw %}{% link _manual/contribute/style-guides/index.md %}{% endraw %}).
- It's recommended you [set up precommit hooks]({% raw %}{% link _manual/contribute/developer-guide.md %}{% endraw %}) to auto-format when you commit.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ parent: Contribute
---
## Git Commit Message Format Guide

Commits are required to be conventional git commit messages. This helps with the auto-generation of the changelog files and is enforced by pre-commit.
Commits are required to be conventional git commit messages. This helps with the auto-generation of the changelog files and is enforced by [pre-commit](https://pre-commit.com/).

__example:__

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ This page lists resources for developers who want to contribute to the {{ cookie
### Contribute code to {{ cookiecutter.project_name }}

* [Developer guide]({% raw %}{% link _manual/contribute/developer-guide.md %}{% endraw %})
* [Create a pull request] walks you through preparing a clear, descriptive pull request.
* [Create a pull request]({% raw %}{% link _manual/contribute/create-pull-request.md %}{% endraw %}) walks you through preparing a clear, descriptive pull request.
* [Create a feature request]({% raw %}{% link _manual/contribute/create-feature-request.md %}{% endraw %})
* [Merge a pull request]({% raw %}{% link _manual/contribute/merge-pull-request.md %}{% endraw %})
* Browse all [issues]({{ cookiecutter.repo_url }}/issues/new) to find a good first task. <!-- You can also filter by [help wanted](). -->
* Browse all [issues]({{ cookiecutter.repo_url }}/issues) to find a good first task. <!-- You can also filter by [help wanted](). -->

### Contribute without code

Expand All @@ -26,7 +26,8 @@ This page lists resources for developers who want to contribute to the {{ cookie

### Best practices and style

Our [style guides]({% raw %}{% link _manual/contribute/style-guides/index.md %}{% endraw %}) outline {{ cookiecutter.project_name }} style for frontend, backend, documentation, and more, including best practices. Please read through them before you start editing or coding!
* [Python style guide]({% raw %}{% link _manual/contribute/style-guides/python.md %}{% endraw %}).
* [Typescript style guide]({% raw %}{% link _manual/contribute/style-guides/typescript.md %}{% endraw %}).
* [YAML style guide]({% raw %}{% link _manual/contribute/style-guides/yaml.md %}{% endraw %}).
Our [style guides]({% raw %}{% link _manual/contribute/style-guides/index.md %}{% endraw %}) outline {{ cookiecutter.project_name }} style for frontend, backend, documentation, and more, including best practices. Please read through them before you start editing or coding!

* [Python style guide]({% raw %}{% link _manual/contribute/style-guides/python.md %}{% endraw %}).
* [Typescript style guide]({% raw %}{% link _manual/contribute/style-guides/typescript.md %}{% endraw %}).
* [YAML style guide]({% raw %}{% link _manual/contribute/style-guides/yaml.md %}{% endraw %}).
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,49 @@ nav_order: 1
parent: Introduction
---
## Getting started with {{ cookiecutter.project_name }}

1. [Requirements]({% raw %}{% link _manual/setup-guide/requirements.md %}{% endraw %}) include python3, Nutri-Matic (docs & hooks), rust (rustup), and git-cliff (changelogs).
* Python3 Packages
1. [cookiecutter](https://github.com/cookiecutter/cookiecutter) is required to utilize templates from github.
2. [Nutri-Matic](https://github.com/jcook3701/nutri-matic) is required to be sourced in python environment for template cookiecutter hooks to work.

I find that it easiest to clone the nutri-matic repository. Use the included makefile to install all python dependencies with ```make python-install``` from within the cloned directory. Then, source the created file, ```.venv/bin/activate```, or point the below script variable, ```PYTHON_VENV```, to desired python virtual environment.

### Examples

Bash script can be copied and pasted into a shell file. Then, used to begin generating new projects.

__Template Options:__
* [cookiecutter-cookiecutter](https://github.com/jcook3701/cookiecutter-cookiecutter) to generate new cookiecutter template projects.
* [python3-cookiecutter](https://github.com/jcook3701/python3-cookiecutter) to generate python3 projects.
* [ansible-cookiecutter](https://github.com/jcook3701/ansible-galaxy-cookiecutter) to generate ansible galaxy project.
<!-- TODO: The below repositories are planned future work. -->
<!-- * ansible-config-cookiecutter to generate local ansible configuration. -->
<!-- * [typescript-cookiecutter](https://github.com/jcook3701/typescript-cookiecutter) to generate typescript project. -->
<!-- * chrome-extension-cookiecutter to generate google chrome extension project. -->
<!-- * [ROS2-cookiecutter](https://github.com/jcook3701/ROS2-cookiecutter) to generate Robot2 Operating System Package. -->
<!-- TODO: Figure out how I want to display documentation templates. -->
<!-- * [github-docs-cookiecutter](https://github.com/jcook3701/github-docs-cookiecutter) to add documentation to a templates [github pages](https://docs.github.com/en/pages). -->
<!-- * [sphinx-docs-cookiecutter](https://github.com/jcook3701/sphinx-cookiecutter) to add python documentation generated by [Sphinx](https://github.com/sphinx-doc/sphinx). -->

```shell
#!/bin/bash

PYTHON_VENV="~/Documents/git_repo/nutri-matic/.venv/bin/activate"

PROJECT_NAME="example project name"
TEMPLATE="cookiecutter-cookiecutter"
LICENSE="AGPL-3.0-or-later"
BRANCH="main"
DESCRIPTION="Example cookiecutter template project."

rm -rf $PROJECT_NAME/
source $PYTHON_VENV
cookiecutter git@github.com:jcook3701/$TEMPLATE.git \
--checkout $BRANCH \
--no-input \
project_name=$PROJECT_NAME \
description=$DESCRIPTION \
license=$LICENSE
deactivate
```
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,6 @@ nav_order: 1
has_children: true
---
## Introduction to {{ cookiecutter.project_name }}

<!-- * [Installation Guide]({% raw %}{% link _manual/introduction/installation-guide.md %}{% endraw %}) -->
* [Getting Started]({% raw %}{% link _manual/introduction/getting-started.md %}{% endraw %})
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
layout: default
title: "Installation Guide"
nav_order: 1
parent: Introduction
---
## Installation Guide for {{ cookiecutter.project_name }} (Linux)
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ has_children: true
---
## {{ cookiecutter.project_name }} Setup

1. Install all [requirements]({% raw %}{%link link _manual/setup-guide/requirements.md %}{% endraw %}) to effectively pull and utilize cookiecutter template repository effectively.
1. Install all [requirements]({% raw %}{% link _manual/setup-guide/requirements.md %}{% endraw %}) to effectively pull and utilize cookiecutter template repository effectively.
Loading
Loading