render-engine / render-engine-themes-template

build Render Engine Themes with this cookiecutter template

Building from this repo

Important this section should be removed from your version.

Clone from this template

• visit this repo on GitHub
• select "Use this Template"
• create a unique name for your theme

Replacing variables

There are some templates that you should replace with your variables.

There is an abbreviations.json that you can swap the values with your data. Then run the post_template_build.py

python post_template_build.py

WARNING Reminder Remove this section

How to use this theme

1. Install the theme

   pip install <render_engine_PACKAGE_NAME>

2. Import the theme into your project

from render_engine import Site
from <PACKAGE_NAME> import <THEME_CLASS>


app = Site()
app.register_theme(<THEME_CLASS>)

render-engine-themes-template's Issues

What are the base files?

The recommendation is that template file names should be consistent across templates.

create cookiecutter-json and project folder

Cookiecutter projects need a cookiecutter.json and a {{cookiecutter.project_folder}} where generated files will be built

Add tests for templates

There are currently no testS for this package. Please check back later.

- [ ] Test Automation that changes content of the file
- [ ] Test all mentioned values in `abbreviations.json` are discoverable in the project

Update dependabot upgrades

Create a PR Template and an Issue Template to make contributing easier

We need to create a pull request template and issue templates for this repo to make contributing to it easier.

You may reference the templates at the main render engine repo to help you.

We only need to create templates here just like the ones on the main repo.

Remove cookiecutter and use GitHub templates

While the base is using cookiecutter, I feel is it a better user workflow to use GitHub templates.