{"id":35072566,"url":"https://github.com/jcook3701/github-docs-cookiecutter","last_synced_at":"2026-03-15T23:42:23.999Z","repository":{"id":321855980,"uuid":"145486431","full_name":"jcook3701/github-docs-cookiecutter","owner":"jcook3701","description":" Github Pages (Jekyll) cookiecutter project; simplify project documentation.","archived":false,"fork":false,"pushed_at":"2026-02-01T00:37:23.000Z","size":256,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2026-02-01T11:44:30.453Z","etag":null,"topics":["cookiecutter","documentation","github-docs","github-pages","github-wiki"],"latest_commit_sha":null,"homepage":"","language":"Makefile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jcook3701.png","metadata":{"files":{"readme":"README.md","changelog":"changelogs/CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":".github/SECURITY.md","support":".github/SUPPORT.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"buy_me_a_coffee":"jcook3701"}},"created_at":"2018-08-21T00:54:27.000Z","updated_at":"2026-02-01T00:36:27.000Z","dependencies_parsed_at":null,"dependency_job_id":"a41b7a3c-4840-4359-886b-21c863db613b","html_url":"https://github.com/jcook3701/github-docs-cookiecutter","commit_stats":null,"previous_names":["jcook3701/github-docs-cookiecutter"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/jcook3701/github-docs-cookiecutter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcook3701%2Fgithub-docs-cookiecutter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcook3701%2Fgithub-docs-cookiecutter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcook3701%2Fgithub-docs-cookiecutter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcook3701%2Fgithub-docs-cookiecutter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jcook3701","download_url":"https://codeload.github.com/jcook3701/github-docs-cookiecutter/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcook3701%2Fgithub-docs-cookiecutter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30555801,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-15T23:30:23.986Z","status":"ssl_error","status_checked_at":"2026-03-15T23:28:43.564Z","response_time":61,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cookiecutter","documentation","github-docs","github-pages","github-wiki"],"created_at":"2025-12-27T11:57:44.826Z","updated_at":"2026-03-15T23:42:23.994Z","avatar_url":"https://github.com/jcook3701.png","language":"Makefile","readme":"\u003c!--\n  Auto-generated file. Do not edit directly.\n  Edit /home/jcook/Documents/git_repo/github-doc-cookiecutter/docs/jekyll/README.md instead.\n  Run ```make readme``` to regenerate this file\n--\u003e\n\u003ch1 id=\"github-docs-cookiecutter\"\u003egithub-docs-cookiecutter\u003c/h1\u003e\n\n\u003cp\u003e\u003ca href=\"LICENSE.md\"\u003e\u003cimg src=\"https://img.shields.io/github/license/jcook3701/github-docs-cookiecutter\" alt=\"License\" /\u003e\u003c/a\u003e\u003c/p\u003e\n\n\u003cp\u003e\u003cstrong\u003eAuthor:\u003c/strong\u003e Jared Cook\u003cbr /\u003e\n\u003cstrong\u003eVersion:\u003c/strong\u003e 0.1.1\u003c/p\u003e\n\n\u003ch2 id=\"overview\"\u003eOverview\u003c/h2\u003e\n\u003cp\u003eGithub docs cookiecutter template generation.\u003c/p\u003e\n\n\u003cp\u003eTemplate cookiecutter project for \u003cstrong\u003eGithub Pages\u003c/strong\u003e (Jekyll).  This project can utilize a variety of different documentation templates but is focused mainly on a clean implementation of \u003cstrong\u003e\u003ca href=\"https://github.com/just-the-docs/just-the-docs\"\u003ejust the docs\u003c/a\u003e\u003c/strong\u003e. Skip the boring \u003cstrong\u003eboilerplate code\u003c/strong\u003e and get to the work that matters.\u003c/p\u003e\n\n\u003chr /\u003e\n\n\u003cp\u003e\u003cstrong\u003eUtilizes:\u003c/strong\u003e\u003cbr /\u003e\nThe \u003cstrong\u003egithub-docs-cookiecutter\u003c/strong\u003e depends on the following repositories for its documentation and sub-features.\u003c/p\u003e\n\n\u003cul\u003e\n  \u003cli\u003e\u003cstrong\u003e\u003ca href=\"https://github.com/jcook3701/cookiecutter-cookiecutter\"\u003ecookiecutter-cookiecutter\u003c/a\u003e\u003c/strong\u003e Generates cookiecutter template projects and is able to be queried by generated projects for autogenerated file updates.\u003c/li\u003e\n  \u003cli\u003e\u003cstrong\u003e\u003ca href=\"https://github.com/jcook3701/github-docs-cookiecutter\"\u003eGithub docs\u003c/a\u003e\u003c/strong\u003e via the cookiecutter-cookiecutter this project is used as a sub-template to generate documentation.\u003c/li\u003e\n  \u003cli\u003e\u003cstrong\u003e\u003ca href=\"https://github.com/jcook3701/nutri-matic\"\u003eNutri-Matic\u003c/a\u003e\u003c/strong\u003e cookiecutter hooks and tools for documentation build. The nutrimatic package has become a .\u003c/li\u003e\n\u003c/ul\u003e\n\n\u003cp\u003e\u003cstrong\u003eMaintains:\u003c/strong\u003e\u003cbr /\u003e\nThe \u003cstrong\u003egithub-docs-cookiecutter\u003c/strong\u003e is used to maintain documentation for the following projects.\u003c/p\u003e\n\n\u003cp\u003e\u003cstrong\u003eCookiecutter Projects:\u003c/strong\u003e\u003c/p\u003e\n\u003cul\u003e\n  \u003cli\u003e\u003cstrong\u003e\u003ca href=\"https://github.com/jcook3701/cookiecutter-cookiecutter\"\u003ecookiecutter-cookiecutter\u003c/a\u003e\u003c/strong\u003e\u003c/li\u003e\n  \u003cli\u003e\u003cstrong\u003e\u003ca href=\"https://github.com/jcook3701/python3-cookiecutter\"\u003epython3-cookiecutter\u003c/a\u003e\u003c/strong\u003e\u003c/li\u003e\n  \u003cli\u003e\u003cstrong\u003e\u003ca href=\"https://github.com/jcook3701/ansible-galaxy-cookiecutter\"\u003eansible-galaxy-cookiecutter\u003c/a\u003e\u003c/strong\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\n\u003cp\u003e\u003cstrong\u003ePython Projects:\u003c/strong\u003e\u003c/p\u003e\n\u003cul\u003e\n  \u003cli\u003e\u003cstrong\u003e\u003ca href=\"https://github.com/jcook3701/nutri-matic\"\u003eNutri-Matic\u003c/a\u003e\u003c/strong\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\n\u003cp\u003e\u003cstrong\u003eAnsible Projects:\u003c/strong\u003e\u003c/p\u003e\n\u003cul\u003e\n  \u003cli\u003e\u003cstrong\u003e\u003ca href=\"https://github.com/jcook3701/jcook3701.docker\"\u003ejcook3701.docker\u003c/a\u003e\u003c/strong\u003e Ansible Galaxy collection used to install docker packages.\u003c/li\u003e\n  \u003cli\u003e\u003cstrong\u003e\u003ca href=\"https://github.com/jcook3701/jcook3701.flatpak\"\u003ejcook3701.flatpak\u003c/a\u003e\u003c/strong\u003e Ansible Galaxy collection used to install flatpak packages.\u003c/li\u003e\n  \u003cli\u003e\u003cstrong\u003e\u003ca href=\"https://github.com/jcook3701/jcook3701.pkgs\"\u003ejcook3701.pkgs\u003c/a\u003e\u003c/strong\u003e Ansible Galaxy collection used to install system (Debian, Ubuntu, RHEL) packages.\u003c/li\u003e\n  \u003cli\u003e\u003cstrong\u003e\u003ca href=\"https://github.com/jcook3701/jcook3701.source\"\u003ejcook3701.source\u003c/a\u003e\u003c/strong\u003e Ansible Galaxy collection used to install packages from source code.\u003c/li\u003e\n  \u003cli\u003e\u003cstrong\u003e\u003ca href=\"https://github.com/jcook3701/jcook3701.snap\"\u003ejcook3701.snap\u003c/a\u003e\u003c/strong\u003e Ansible Galaxy collection used to install snap packages.\u003c/li\u003e\n\u003c/ul\u003e\n\n\u003chr /\u003e\n\n\u003cp\u003e🛠️ \u003cstrong\u003eCI/CD Check List:\u003c/strong\u003e\u003c/p\u003e\n\n\u003c!-- [![CLA assistant](https://github.com/jcook3701/github-docs-cookiecutter/actions/workflows/cla.yml/badge.svg)]() --\u003e\n\u003cul\u003e\n  \u003cli\u003e\u003cimg src=\"https://github.com/jcook3701/github-docs-cookiecutter/actions/workflows/dependency-check.yml/badge.svg\" alt=\"dependency-check\" /\u003e\u003c/li\u003e\n  \u003cli\u003e\u003cimg src=\"https://github.com/jcook3701/github-docs-cookiecutter/actions/workflows/format-check.yml/badge.svg\" alt=\"format-check\" /\u003e\u003c/li\u003e\n  \u003cli\u003e\u003cimg src=\"https://github.com/jcook3701/github-docs-cookiecutter/actions/workflows/lint-check.yml/badge.svg\" alt=\"lint-check\" /\u003e\u003c/li\u003e\n  \u003cli\u003e\u003cimg src=\"https://github.com/jcook3701/github-docs-cookiecutter/actions/workflows/security-audit.yml/badge.svg\" alt=\"security-audit\" /\u003e\u003c/li\u003e\n  \u003cli\u003e\u003cimg src=\"https://github.com/jcook3701/github-docs-cookiecutter/actions/workflows/spellcheck.yml/badge.svg\" alt=\"spellcheck\" /\u003e\u003c/li\u003e\n  \u003cli\u003e\u003cimg src=\"https://github.com/jcook3701/github-docs-cookiecutter/actions/workflows/tests.yml/badge.svg\" alt=\"tests\" /\u003e\u003c/li\u003e\n  \u003cli\u003e\u003cimg src=\"https://github.com/jcook3701/github-docs-cookiecutter/actions/workflows/typecheck.yml/badge.svg\" alt=\"typecheck\" /\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\n\u003chr /\u003e\n\n\u003ch2 id=\"usage-examples\"\u003eUsage Examples\u003c/h2\u003e\n\n\u003cp\u003e\u003cstrong\u003eExample:\u003c/strong\u003e Pull from main branch.\u003c/p\u003e\n\u003col\u003e\n  \u003cli\u003ePull Project with cookiecutter command:\n    \u003cdiv class=\"language-shell highlighter-rouge\"\u003e\u003cdiv class=\"highlight\"\u003e\u003cpre class=\"highlight\"\u003e\u003ccode\u003e\u003cspan class=\"nv\"\u003e$ \u003c/span\u003ecookiecutter git@github.com:jcook3701/github-docs-cookiecutter.git  \n\u003c/code\u003e\u003c/pre\u003e\u003c/div\u003e    \u003c/div\u003e\n    \u003cp\u003e\u003cstrong\u003eExample:\u003c/strong\u003e Pull from develop branch.\u003c/p\u003e\n  \u003c/li\u003e\n  \u003cli\u003ePull code from development branch while testing updates.\n    \u003cdiv class=\"language-shell highlighter-rouge\"\u003e\u003cdiv class=\"highlight\"\u003e\u003cpre class=\"highlight\"\u003e\u003ccode\u003e\u003cspan class=\"nv\"\u003e$ \u003c/span\u003ecookiecutter git@github.com:jcook3701/github-docs-cookiecutter.git \u003cspan class=\"nt\"\u003e--checkout\u003c/span\u003e develop  \n\u003c/code\u003e\u003c/pre\u003e\u003c/div\u003e    \u003c/div\u003e\n  \u003c/li\u003e\n\u003c/ol\u003e\n\n\u003ch2 id=\"advance-examples\"\u003eAdvance Examples\u003c/h2\u003e\n\n\u003cp\u003e\u003cstrong\u003eNote:\u003c/strong\u003e The real intention of this project is to call it as a hook within other cookiecutter projects as shown below.\u003cbr /\u003e\n\u003cstrong\u003eExplanation:\u003c/strong\u003e \u003ca href=\"https://github.com/jcook3701/ansible-galaxy-cookiecutter\"\u003eansible-galaxy-cookiecutter\u003c/a\u003e template utilizes \u003ca href=\"https://github.com/jcook3701/nutri-matic\"\u003enutri-matic\u003c/a\u003e hooks to pull both this documentation template along with \u003ca href=\"https://github.com/jcook3701/sphinx-cookiecutter\"\u003esphinx-cookiecutter\u003c/a\u003e template into generated project \u003ccode class=\"language-plaintext highlighter-rouge\"\u003e$(PROJECT_ROOT)/docs/\u003c/code\u003e.\u003c/p\u003e\n\n\u003cp\u003eUtilization of \u003ca href=\"https://github.com/jcook3701/nutri-matic\"\u003enutri-matic\u003c/a\u003e is the optimal way of integrating this template in projects.\u003c/p\u003e\n\n\u003chr /\u003e\n\n\u003ch2 id=\"-getting-started\"\u003e🌱 Getting Started\u003c/h2\u003e\n\n\u003cul\u003e\n  \u003cli\u003e\u003ca href=\"https://jcook3701.github.io/github-docs-cookiecutter/manual/setup-guide/requirements\"\u003eRequirements\u003c/a\u003e\u003c/li\u003e\n  \u003cli\u003e\u003ca href=\"https://jcook3701.github.io/github-docs-cookiecutter/manual/introduction/installation-guide\"\u003eInstallation guide\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\n\u003ch2 id=\"-documentation\"\u003e📚 Documentation\u003c/h2\u003e\n\n\u003cp\u003eThe github-docs-cookiecutter documentation is available at \u003ca href=\"https://jcook3701.github.io/github-docs-cookiecutter\"\u003edocs\u003c/a\u003e.\u003c/p\u003e\n\n\u003ch2 id=\"-contributing\"\u003e🤝 Contributing\u003c/h2\u003e\n\n\u003cp\u003eIf you’re interested in contributing to the github-docs-cookiecutter project:\u003c/p\u003e\n\u003cul\u003e\n  \u003cli\u003eStart by reading the \u003ca href=\"https://jcook3701.github.io/github-docs-cookiecutter/manual/developer-resources/contribute\"\u003econtributing guide\u003c/a\u003e.\u003c/li\u003e\n  \u003cli\u003eLearn how to setup your local environment, in our \u003ca href=\"https://jcook3701.github.io/github-docs-cookiecutter/manual/contribute/developer-guide\"\u003edeveloper guide\u003c/a\u003e.\u003c/li\u003e\n  \u003cli\u003eLook through our \u003ca href=\"https://jcook3701.github.io/github-docs-cookiecutter/manual/contribute/style-guides/index\"\u003estyle guide\u003c/a\u003e.\u003c/li\u003e\n\u003c/ul\u003e\n\n\u003chr /\u003e\n\n\u003ch2 id=\"-authors-notes\"\u003e🍹 Authors Notes\u003c/h2\u003e\n\n\u003col\u003e\n  \u003cli\u003eThis code currently works with cookiecutter (2.6) from PyPi repositories.\u003c/li\u003e\n\u003c/ol\u003e\n\n\u003ch2 id=\"️-license\"\u003e⚖️ License\u003c/h2\u003e\n\n\u003cp\u003eCopyright (c) 2025-2026, Jared Cook\u003c/p\u003e\n\n\u003cp\u003eThis project is licensed under the \u003cstrong\u003eAGPL-3.0-or-later License\u003c/strong\u003e.\u003cbr /\u003e\nSee the \u003ca href=\"https://github.com/jcook3701/github-docs-cookiecutter/blob/master/LICENSE.md\"\u003eLICENSE\u003c/a\u003e file for the full license text.\u003c/p\u003e\n\n\u003cp\u003eSPDX-License-Identifier: AGPL-3.0-or-later\u003c/p\u003e\n","funding_links":["https://buymeacoffee.com/jcook3701"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjcook3701%2Fgithub-docs-cookiecutter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjcook3701%2Fgithub-docs-cookiecutter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjcook3701%2Fgithub-docs-cookiecutter/lists"}