diff --git a/.github/PULL_REQUEST_TEMPLATE/02-bug_fix.md b/.github/PULL_REQUEST_TEMPLATE/02-bug_fix.md deleted file mode 100644 index 1fa1f3a..0000000 --- a/.github/PULL_REQUEST_TEMPLATE/02-bug_fix.md +++ /dev/null @@ -1,20 +0,0 @@ -## ๐Ÿž Bug Fix Description - - -**Related Issue:** Fixes # - -### ๐Ÿ› ๏ธ Changes Made -- [ ] List specific changes or files modified. -- [ ] Describe how the fix addresses the root cause. - -### ๐Ÿงช How to Reproduce & Test -1. **Steps to reproduce:** (e.g., click X, then Y) -2. **Current behavior:** (before this fix) -3. **Expected behavior:** (after this fix) -4. **Testing performed:** (e.g., ran `pytest` or actions performed to recreate live testing situation) - -### โœ… Checklist -- [ ] My code follows the project style guidelines. -- [ ] I have performed a self-review of my code. -- [ ] I have added tests that prove my fix is effective. -- [ ] All new and existing tests passed. diff --git a/.github/PULL_REQUEST_TEMPLATE/03-feature_request.md b/.github/PULL_REQUEST_TEMPLATE/03-feature_request.md deleted file mode 100644 index 0301212..0000000 --- a/.github/PULL_REQUEST_TEMPLATE/03-feature_request.md +++ /dev/null @@ -1,21 +0,0 @@ -## โœจ New Feature Description - - -**Related Issue:** Resolves # - -### ๐Ÿš€ Proposed Changes -- [ ] Detail the new components, logic, or UI added. -- [ ] Mention any new dependencies introduced. - -### ๐Ÿ“ธ Screenshots / Demos (If Applicable) - - -### ๐Ÿ› ๏ธ Technical Details -- [ ] Architecture changes (if any). -- [ ] New environment variables or configurations required. - -### โœ… Checklist -- [ ] My code follows the project style guidelines. -- [ ] I have updated the documentation accordingly. -- [ ] I have added/updated tests for this feature. -- [ ] My changes generate no new warnings or console errors. diff --git a/README.md b/README.md index b7ec02a..e68008b 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,7 @@

License

+

dependency-check format-check lint-check diff --git a/changelogs/CHANGELOG.md b/changelogs/CHANGELOG.md index 22e6dca..564c9ad 100644 --- a/changelogs/CHANGELOG.md +++ b/changelogs/CHANGELOG.md @@ -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 diff --git a/changelogs/releases/v0.1.1.md b/changelogs/releases/v0.1.1.md index cd6ba48..fe3e71d 100644 --- a/changelogs/releases/v0.1.1.md +++ b/changelogs/releases/v0.1.1.md @@ -2,7 +2,7 @@ # Changelog: # -------------------------------------------------- -## [0.1.1] - 2026-01-27 +## [0.1.1] - 2026-01-29 ### โš™๏ธ Miscellaneous @@ -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. diff --git a/cookiecutter.json b/cookiecutter.json index a358eb3..19a0c40 100644 --- a/cookiecutter.json +++ b/cookiecutter.json @@ -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": [ diff --git a/docs/cookiecutter_input.json b/docs/cookiecutter_input.json index 29bef7a..7e4f101 100644 --- a/docs/cookiecutter_input.json +++ b/docs/cookiecutter_input.json @@ -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" diff --git a/docs/jekyll/Gemfile.lock b/docs/jekyll/Gemfile.lock index 55cfefa..20980aa 100644 --- a/docs/jekyll/Gemfile.lock +++ b/docs/jekyll/Gemfile.lock @@ -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) @@ -112,6 +113,9 @@ PLATFORMS x86_64-linux DEPENDENCIES + base64 + bigdecimal + csv faraday (~> 2.14) faraday-retry (~> 2.3) jekyll (~> 4.4) @@ -122,6 +126,7 @@ DEPENDENCIES jekyll-seo-tag jekyll-sitemap just-the-docs (~> 0.11) + logger BUNDLED WITH 2.5.23 diff --git a/docs/jekyll/README.md b/docs/jekyll/README.md index a1fae5d..07585e3 100644 --- a/docs/jekyll/README.md +++ b/docs/jekyll/README.md @@ -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) + ![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) diff --git a/{{ cookiecutter.project_slug }}/Makefile b/{{ cookiecutter.project_slug }}/Makefile index fd65da4..7d9b37e 100644 --- a/{{ cookiecutter.project_slug }}/Makefile +++ b/{{ cookiecutter.project_slug }}/Makefile @@ -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 # -------------------------------------------------- diff --git a/{{ cookiecutter.project_slug }}/README.md b/{{ cookiecutter.project_slug }}/README.md index 20b8bb6..90f43a6 100644 --- a/{{ cookiecutter.project_slug }}/README.md +++ b/{{ cookiecutter.project_slug }}/README.md @@ -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 }} @@ -18,24 +18,25 @@ __CI/CD Check List:__ * ![typecheck]({{ site.repo_url }}/actions/workflows/typecheck.yml/badge.svg) *** + + ## 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 }} diff --git a/{{ cookiecutter.project_slug }}/_config.yml b/{{ cookiecutter.project_slug }}/_config.yml index 8a04f69..2d4975e 100755 --- a/{{ cookiecutter.project_slug }}/_config.yml +++ b/{{ cookiecutter.project_slug }}/_config.yml @@ -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 }}" diff --git a/{{ cookiecutter.project_slug }}/_manual/contribute/create-feature-request.md b/{{ cookiecutter.project_slug }}/_manual/contribute/create-feature-request.md index f6b187e..4cdc394 100644 --- a/{{ cookiecutter.project_slug }}/_manual/contribute/create-feature-request.md +++ b/{{ cookiecutter.project_slug }}/_manual/contribute/create-feature-request.md @@ -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. +* Browse all [issues]({{ cookiecutter.repo_url }}/issues) to find a good first task. ### Contribute without code @@ -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 %}). diff --git a/{{ cookiecutter.project_slug }}/_manual/introduction/getting-started.md b/{{ cookiecutter.project_slug }}/_manual/introduction/getting-started.md index 616c651..a51a5ce 100644 --- a/{{ cookiecutter.project_slug }}/_manual/introduction/getting-started.md +++ b/{{ cookiecutter.project_slug }}/_manual/introduction/getting-started.md @@ -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. + + + + + + + + + +```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 +``` diff --git a/{{ cookiecutter.project_slug }}/_manual/introduction/index.md b/{{ cookiecutter.project_slug }}/_manual/introduction/index.md index df9bb29..50e7fe8 100644 --- a/{{ cookiecutter.project_slug }}/_manual/introduction/index.md +++ b/{{ cookiecutter.project_slug }}/_manual/introduction/index.md @@ -5,3 +5,6 @@ nav_order: 1 has_children: true --- ## Introduction to {{ cookiecutter.project_name }} + + +* [Getting Started]({% raw %}{% link _manual/introduction/getting-started.md %}{% endraw %}) diff --git a/{{ cookiecutter.project_slug }}/_manual/introduction/installation-guide.md b/{{ cookiecutter.project_slug }}/_manual/introduction/installation-guide.md new file mode 100644 index 0000000..ee4e8df --- /dev/null +++ b/{{ cookiecutter.project_slug }}/_manual/introduction/installation-guide.md @@ -0,0 +1,7 @@ +--- +layout: default +title: "Installation Guide" +nav_order: 1 +parent: Introduction +--- +## Installation Guide for {{ cookiecutter.project_name }} (Linux) diff --git a/{{ cookiecutter.project_slug }}/_manual/setup-guide/index.md b/{{ cookiecutter.project_slug }}/_manual/setup-guide/index.md index 9d77bd2..f214d3c 100644 --- a/{{ cookiecutter.project_slug }}/_manual/setup-guide/index.md +++ b/{{ cookiecutter.project_slug }}/_manual/setup-guide/index.md @@ -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. diff --git a/{{ cookiecutter.project_slug }}/_manual/setup-guide/requirements.md b/{{ cookiecutter.project_slug }}/_manual/setup-guide/requirements.md index 2f25f9d..cddaba2 100644 --- a/{{ cookiecutter.project_slug }}/_manual/setup-guide/requirements.md +++ b/{{ cookiecutter.project_slug }}/_manual/setup-guide/requirements.md @@ -9,11 +9,11 @@ parent: "Setup Guide" 1. Python 3.11 ```shell - $ sudo apt install python3.11 + $ sudo apt install python3.11 python3.11-dev python3.11-venv ``` 2. [Nutri-Matic](https://github.com/jcook3701/nutri-matic) __Note:__ - __Example:__ Install with the following command (Recommended that this is installed in a python virtual environment): + __Example:__ Install with the following command (Recommended that this is installed in a python [virtual environment]({% raw %}{% link _manual/tutorials/create-virtual-env.md %}{% endraw %})): ```shell $ python -m pip install nutri-matic ``` diff --git a/{{ cookiecutter.project_slug }}/_manual/troubleshooting/faq.md b/{{ cookiecutter.project_slug }}/_manual/troubleshooting/faq.md new file mode 100644 index 0000000..1be7c02 --- /dev/null +++ b/{{ cookiecutter.project_slug }}/_manual/troubleshooting/faq.md @@ -0,0 +1,8 @@ +--- +layout: default +title: Requirements +nav_order: 1 +parent: Troubleshooting +--- + +## {{ cookiecutter.project_name }} Frequently Asked Questions diff --git a/{{ cookiecutter.project_slug }}/_manual/troubleshooting/index.md b/{{ cookiecutter.project_slug }}/_manual/troubleshooting/index.md index a3b648a..fa25f41 100644 --- a/{{ cookiecutter.project_slug }}/_manual/troubleshooting/index.md +++ b/{{ cookiecutter.project_slug }}/_manual/troubleshooting/index.md @@ -5,3 +5,5 @@ nav_order: 1 has_children: true --- ## Troubleshooting {{ cookiecutter.project_name }} + +* **[FAQ]({% raw %}{% link _manual/troubleshooting/faq.md %}{% endraw %})** Common questions are answered in our [Frequently Asked Questions]({{ cookiecutter.github_io }}/manual/troubleshooting/faq.md). diff --git a/{{ cookiecutter.project_slug }}/_manual/tutorials/create-virtual-env.md b/{{ cookiecutter.project_slug }}/_manual/tutorials/create-virtual-env.md new file mode 100644 index 0000000..bb8d7fc --- /dev/null +++ b/{{ cookiecutter.project_slug }}/_manual/tutorials/create-virtual-env.md @@ -0,0 +1,27 @@ +--- +layout: default +title: Create Virtual Environment +nav_order: 1 +parent: Tutorials +--- +## Install Python3 and Python Virtual Environment + +Either install python 3.10 or 3.11. Below example is to install python 3.11, however, to install and utilize python 3.10 just replace '11' with '10' in each instance below. + +```shell +$ sudo apt install python3.11 python3.11-dev python3.11-venv +``` + +## Create Virtual Environment (Python) + +First you need to decide where you would like you virtual environment to be stored. Personally I use ```~/Documents/python3-venvs``` to store utility python environments. After creating the directory where you would like to store you python environments move into it and run the below command. + +``` shell +$ python3.11 -m venv nutri-matic-venv +``` + +Then source into that python environment. + +```shell +$ source ./nutri-matic-venv/bin/activate +``` diff --git a/{{ cookiecutter.project_slug }}/_manual/tutorials/index.md b/{{ cookiecutter.project_slug }}/_manual/tutorials/index.md index ab2b6a0..4701faf 100644 --- a/{{ cookiecutter.project_slug }}/_manual/tutorials/index.md +++ b/{{ cookiecutter.project_slug }}/_manual/tutorials/index.md @@ -5,3 +5,6 @@ nav_order: 1 has_children: true --- ## {{ cookiecutter.project_name }} Tutorials + +* [Create Virtual Environment]({% raw %}{% link _manual/tutorials/create-virtual-env.md %}{% endraw %}) +* [Nutri-Matic]({% raw %}{% link _manual/tutorials/nutri-matic.md %}{% endraw %}) diff --git a/{{ cookiecutter.project_slug }}/_manual/tutorials/nutri-matic.md b/{{ cookiecutter.project_slug }}/_manual/tutorials/nutri-matic.md new file mode 100644 index 0000000..6bcf81a --- /dev/null +++ b/{{ cookiecutter.project_slug }}/_manual/tutorials/nutri-matic.md @@ -0,0 +1,25 @@ +--- +layout: default +title: "Nutri-Matic" +nav_order: 1 +parent: Tutorials +--- +## Nutri-Matic Setup + +First clone the [Nutri-Matic](https://github.com/jcook3701/nutri-matic) python utility. This is needed to clone all [jcook3701's](https://github.com/jcook3701), cookiecutter templates, with the ```cookiecutter``` command. + +```shell +$ git clone git@github.com:jcook3701/nutri-matic.git +``` + +Next, move into the newly cloned directory, ```cd nutri-matic``` . Then utilize the [developer guide]({% raw %}{% link _manual/contribute/developer-guide.md %}{% endraw %}) process and run ```make python-install``` to create a python virtual environment stored within the, ```.venv```, folder. This ensures the latest version of nutri-matic code and is very helpful for development on any of the template repositories. + +Finally, source Nutri-Matic's created virtual environment with the directory, ```.venv```, and begin generating templates. + +```shell +$ source .venv/bin/active +``` + +The Nutri-Matic package is responsible for managing all [jcook3701's](https://github.com/jcook3701) cookiecutter template hooks and build features. + +After the environment is sourced and other project dependencies are installed; templates should be able to be generated using the commands found in our [getting started]({% raw %}{% link _manual/introduction/getting-started.md %}{% endraw %}) guide. diff --git a/{{ cookiecutter.project_slug }}/index.md b/{{ cookiecutter.project_slug }}/index.md index 84932e8..af0ff06 100644 --- a/{{ cookiecutter.project_slug }}/index.md +++ b/{{ cookiecutter.project_slug }}/index.md @@ -4,9 +4,7 @@ title: {{ cookiecutter.project_name }} nav_order: 1 description: {{ cookiecutter.description }} --- - -{% raw %} - +{%- raw %} {% include snippet_loader.html %} {% if site.carousel_images %} @@ -21,5 +19,4 @@ If you enjoy this project, please consider buying me a coffee or making a code c ## Social Links {% include social-bar.html %} - {% endraw %}