diff --git a/.jinja-runtime.json b/.jinja-runtime.json index 4cc19f4..b7cd767 100644 --- a/.jinja-runtime.json +++ b/.jinja-runtime.json @@ -7,12 +7,8 @@ ], "base_dir": "." }, - "env": { - "globals": { - "cookiecutter": { - "project_slug": "example_project", - "chosen_license": "MIT" - } - } + "_jinja2_env_vars": { + "lstrip_blocks": true, + "trim_blocks": true } } diff --git a/changelogs/CHANGELOG.md b/changelogs/CHANGELOG.md index 0442e95..c811764 100644 --- a/changelogs/CHANGELOG.md +++ b/changelogs/CHANGELOG.md @@ -130,17 +130,28 @@ Feat 012 (#39) - Merge pull request #42 from jcook3701/develop Feat 013 (#41) +- Feat 014 (#43) + +* fix(links): Fix for document links. + +* fix(links): More link fixes. + +* feat(docs): Added variables to jekyll configuration. + +* fix(upgrader): Fixed upgrader file. +- Merge pull request #44 from jcook3701/develop + +Feat 014 (#43) ### 🐛 Fixed - *(template)* Updates to template cookiecutter.json file. -- *(links)* Fix for document links. -- *(links)* More link fixes. -- *(upgrader)* Fixed upgrader file. +- *(links)* More link fixes along with a few configuration fixes to remove warnings. ### 🚀 Added -- *(docs)* Added variables to jekyll configuration. +- *(links)* More links and general docs template updates. +- *(docs)* Documentation updates. ## [0.1.0] - 2025-12-05 ### ⚙️ Miscellaneous diff --git a/changelogs/releases/v0.1.1.md b/changelogs/releases/v0.1.1.md index 80a1be8..2f71ff2 100644 --- a/changelogs/releases/v0.1.1.md +++ b/changelogs/releases/v0.1.1.md @@ -130,14 +130,25 @@ Feat 012 (#39) - Merge pull request #42 from jcook3701/develop Feat 013 (#41) +- Feat 014 (#43) + +* fix(links): Fix for document links. + +* fix(links): More link fixes. + +* feat(docs): Added variables to jekyll configuration. + +* fix(upgrader): Fixed upgrader file. +- Merge pull request #44 from jcook3701/develop + +Feat 014 (#43) ### 🐛 Fixed - *(template)* Updates to template cookiecutter.json file. -- *(links)* Fix for document links. -- *(links)* More link fixes. -- *(upgrader)* Fixed upgrader file. +- *(links)* More link fixes along with a few configuration fixes to remove warnings. ### 🚀 Added -- *(docs)* Added variables to jekyll configuration. +- *(links)* More links and general docs template updates. +- *(docs)* Documentation updates. diff --git a/cookiecutter.json b/cookiecutter.json index 0a6ca3e..cc20a83 100644 --- a/cookiecutter.json +++ b/cookiecutter.json @@ -32,6 +32,7 @@ "ga_tracking": "G-C7PWLWSHB9", "github_org": null, "github_username": "jcook3701", + "github_io": "https://{{ cookiecutter.github_username }}.github.io/{{ cookiecutter.project_slug }}", "twitter_username": "", "linkedin_usercode": "jared-cook-b3585a114", "buymeacoffee_username": "jcook3701", diff --git a/docs/cookiecutter_input.json b/docs/cookiecutter_input.json index be6da46..f93db28 100644 --- a/docs/cookiecutter_input.json +++ b/docs/cookiecutter_input.json @@ -48,6 +48,7 @@ "description": "Github docs cookiecutter template generation.", "email": "jcook3701+github@gmail.com", "ga_tracking": "G-C7PWLWSHB9", + "github_io": "https://jcook3701.github.io/github-docs-cookiecutter", "github_org": null, "github_username": "jcook3701", "license": "AGPL-3.0-or-later", diff --git a/docs/jekyll/Makefile b/docs/jekyll/Makefile index dd4d162..ba02dcd 100644 --- a/docs/jekyll/Makefile +++ b/docs/jekyll/Makefile @@ -86,12 +86,7 @@ help: $(AT)echo " version: $(PACKAGE_VERSION)" $(AT)echo "" $(AT)echo "Usage:" - $(AT)echo " make ruby-inst\ - - - - fddjfsal;dsjfklas;jdklf;JINJA_FILE_LIST - sall Installs Gemfile packages." + $(AT)echo " make ruby-install Installs Gemfile packages." $(AT)echo " make build Generate Jekyll documentation" $(AT)echo " make run Serve Jekyll site locally" $(AT)echo " make clean Clean Jekyll build artifacts" diff --git a/{{ cookiecutter.project_slug }}/Gemfile b/{{ cookiecutter.project_slug }}/Gemfile index d242ae4..0c08968 100755 --- a/{{ cookiecutter.project_slug }}/Gemfile +++ b/{{ cookiecutter.project_slug }}/Gemfile @@ -6,6 +6,11 @@ gem "faraday-retry", "~> 2.3" gem "jekyll", "~> 4.4" gem "just-the-docs", "~> 0.11" +gem "bigdecimal" +gem "csv" +gem "logger" +gem "base64" + group :jekyll_plugins do gem "jekyll-seo-tag" gem "jekyll-sitemap" diff --git a/{{ cookiecutter.project_slug }}/README.md b/{{ cookiecutter.project_slug }}/README.md index 0fc5cca..20b8bb6 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) +[![License](https://img.shields.io/github/license/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }})](LICENSE.md) __Author:__ {{ site.author }} __Version:__ {{ site.version }} @@ -19,16 +19,23 @@ __CI/CD Check List:__ *** -## Usage Examples +## Getting Started +* [Get {{ cookiecutter.project_name}}] +* [Installation guides] -## Advance Examples +## Documentation +The {{ cookiecutter.project_name }} documentation is available at [docs]({{ site.github_io_url }}) -## Development Strategy +## 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). ## License {{ cookiecutter.copyright }} This project is licensed under the __{{ cookiecutter.license }} License__. -See the [LICENSE](LICENSE) file for the full license text. +See the [LICENSE]({{ site.repo_blob }}/LICENSE.md) file for the full license text. SPDX-License-Identifier: {{ cookiecutter.license }} diff --git a/{{ cookiecutter.project_slug }}/_config.yml b/{{ cookiecutter.project_slug }}/_config.yml index 54045a5..48aa56e 100755 --- a/{{ cookiecutter.project_slug }}/_config.yml +++ b/{{ cookiecutter.project_slug }}/_config.yml @@ -9,8 +9,8 @@ remote_theme: "{{ cookiecutter.theme }}" ga_tracking: "{{ cookiecutter.ga_tracking }}" repo_url: "{{ cookiecutter.repo_url }}" -repo_blob: "{{cookiecutter.repo_url }}/blob/{{ cookiecutter._checkout }}/" -github_io_url: "https://{{ cookiecutter.github_username }}.github.io/" +repo_blob: "{{cookiecutter.repo_url }}/blob/{{ cookiecutter._checkout }}" +github_io_url: "{{ cookiecutter.github_io }}" repository: "{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}" # Specifies the site's subpath for correct URL generation @@ -102,7 +102,7 @@ back_to_top_text: "Back to top" footer_content: >- {{ cookiecutter.copyright }}. Distributed by an - + {{ cookiecutter.license }} license. diff --git a/{{ cookiecutter.project_slug }}/_manual/contribute/developer-guide.md b/{{ cookiecutter.project_slug }}/_manual/contribute/developer-guide.md index 0a92923..1dc2243 100644 --- a/{{ cookiecutter.project_slug }}/_manual/contribute/developer-guide.md +++ b/{{ cookiecutter.project_slug }}/_manual/contribute/developer-guide.md @@ -41,7 +41,7 @@ $ make format-check $ make format-fix ``` -### 🔍 Linting (jinja2-cli, ruff, tomllint, & yaml-lint) +### 🔍 Linting (djlint, ruff, tomllint, & yaml-lint) ``` shell $ make lint-check diff --git a/{{ cookiecutter.project_slug }}/_manual/contribute/index.md b/{{ cookiecutter.project_slug }}/_manual/contribute/index.md index 11b2229..3aeed7c 100644 --- a/{{ cookiecutter.project_slug }}/_manual/contribute/index.md +++ b/{{ cookiecutter.project_slug }}/_manual/contribute/index.md @@ -9,10 +9,13 @@ has_children: true We're excited that you're considering making a contribution to the {{ cookiecutter.project_name }} project! This is the place to find guides for contributors to our open-source project. These are some good resources to explore for developers: -{% raw %} -[Create a pull request]({% link _manual/contribute/create-pull-request.md %}) -[Create a feature request]({% link _manual/contribute/create-feature-request.md %}) -[Developer guide]({% link _manual/contribute/developer-guide.md %}) -[Merge a pull request]({% link _manual/contribute/merge-pull-request.md %}) -{% endraw %} -Find style guides for the {{ cookiecutter.project_name }} software project: + +* [Create a pull request]({% raw %}{% link _manual/contribute/create-pull-request.md %}{% endraw %}) +* [Create a feature request]({% raw %}{% link _manual/contribute/create-feature-request.md %}{% endraw %}) +* [Developer guide]({% raw %}{% link _manual/contribute/developer-guide.md %}{% endraw %}) +* [Merge a pull request]({% raw %}{% link _manual/contribute/merge-pull-request.md %}{% endraw %}) + +Find [style guides]({% raw %}{% link _manual/contribute/style-guides/index.md %}{% endraw %}) for the {{ cookiecutter.project_name }} software project: +* [Python]({% raw %}{% link _manual/contribute/style-guides/python.md %}{% endraw %}) style guide. +* [Typescript]({% raw %}{% link _manual/contribute/style-guides/typescript.md %}{% endraw %}) style guide. +* [YAML]({% raw %}{% link _manual/contribute/style-guides/yaml.md %}{% endraw %}) style guide. diff --git a/{{ cookiecutter.project_slug }}/_manual/contribute/style-guides/index.md b/{{ cookiecutter.project_slug }}/_manual/contribute/style-guides/index.md index f457906..4143951 100644 --- a/{{ cookiecutter.project_slug }}/_manual/contribute/style-guides/index.md +++ b/{{ cookiecutter.project_slug }}/_manual/contribute/style-guides/index.md @@ -7,5 +7,6 @@ parent: Contribute --- ## Style Guides -* [Python](python.md) style guide. -* [Typescript](typescript.md) style guide. +* [Python]({% raw %}{% link _manual/contribute/style-guides/python.md %}{% endraw %}) style guide. +* [Typescript]({% raw %}{% link _manual/contribute/style-guides/typescript.md %}{% endraw %}) style guide. +* [YAML]({% raw %}{% link _manual/contribute/style-guides/yaml.md %}{% endraw %}) style guide. diff --git a/{{ cookiecutter.project_slug }}/_manual/contribute/style-guides/python.md b/{{ cookiecutter.project_slug }}/_manual/contribute/style-guides/python.md index 0201964..c2b3dbf 100644 --- a/{{ cookiecutter.project_slug }}/_manual/contribute/style-guides/python.md +++ b/{{ cookiecutter.project_slug }}/_manual/contribute/style-guides/python.md @@ -4,3 +4,4 @@ title: "Python Style Guide" nav_order: 1 parent: "Style Guide" --- +## Python Style Guide diff --git a/{{ cookiecutter.project_slug }}/_manual/contribute/style-guides/typescript.md b/{{ cookiecutter.project_slug }}/_manual/contribute/style-guides/typescript.md index 9dea0e0..df8c660 100644 --- a/{{ cookiecutter.project_slug }}/_manual/contribute/style-guides/typescript.md +++ b/{{ cookiecutter.project_slug }}/_manual/contribute/style-guides/typescript.md @@ -4,3 +4,4 @@ title: "Typescript Style Guide" nav_order: 1 parent: "Style Guide" --- +## Typescript Style Guide diff --git a/{{ cookiecutter.project_slug }}/_manual/contribute/style-guides/yaml.md b/{{ cookiecutter.project_slug }}/_manual/contribute/style-guides/yaml.md index b3f4b35..815b81d 100644 --- a/{{ cookiecutter.project_slug }}/_manual/contribute/style-guides/yaml.md +++ b/{{ cookiecutter.project_slug }}/_manual/contribute/style-guides/yaml.md @@ -4,3 +4,4 @@ title: "YAML Style Guide" nav_order: 1 parent: "Style Guide" --- +## YAML Style Guide diff --git a/{{ cookiecutter.project_slug }}/_manual/introduction/getting-started.md b/{{ cookiecutter.project_slug }}/_manual/introduction/getting-started.md new file mode 100644 index 0000000..616c651 --- /dev/null +++ b/{{ cookiecutter.project_slug }}/_manual/introduction/getting-started.md @@ -0,0 +1,7 @@ +--- +layout: default +title: Getting Started +nav_order: 1 +parent: Introduction +--- +## Getting started with {{ cookiecutter.project_name }} diff --git a/{{ cookiecutter.project_slug }}/_manual/setup-guide/index.md b/{{ cookiecutter.project_slug }}/_manual/setup-guide/index.md index c84c3f1..9d77bd2 100644 --- a/{{ cookiecutter.project_slug }}/_manual/setup-guide/index.md +++ b/{{ cookiecutter.project_slug }}/_manual/setup-guide/index.md @@ -5,3 +5,5 @@ nav_order: 1 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. diff --git a/{{ cookiecutter.project_slug }}/_manual/setup-guide/requirements.md b/{{ cookiecutter.project_slug }}/_manual/setup-guide/requirements.md index f78c8f6..2f25f9d 100644 --- a/{{ cookiecutter.project_slug }}/_manual/setup-guide/requirements.md +++ b/{{ cookiecutter.project_slug }}/_manual/setup-guide/requirements.md @@ -11,13 +11,19 @@ parent: "Setup Guide" ```shell $ sudo apt install python3.11 ``` -2. [rustup](https://rust-lang.org/tools/install/) +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): + ```shell + $ python -m pip install nutri-matic + ``` +3. [rustup](https://rust-lang.org/tools/install/) __Note:__ I found that it is easiest to use rustup to manage rustc and cargo but this is not required. __Example:__ Install rustup with the following: ```shell $ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh ``` -3. [git-cliff](https://git-cliff.org/) +4. [git-cliff](https://git-cliff.org/) __Note:__ git-cliff can generate changelog files from the Git history by utilizing conventional commits as well as regex-powered custom parsers. ```shell $ cargo install git-cliff