This is the official theme asset template which was used for creating the customa 2022 rewrite's asset repo. This may be used in conjunction with the template repository for themes!
Amongst other things it features:
- Github Workflows Setup which generates an icon font, including usage documentation and hosts asset files on Github pages.
- Shortened gitignore setup featuring ignores for node/npm/yarn, IntelliJ/Jetbrains Tools and VSCode
- Linting and formatting setup (using Prettier (JS, MD,...) and editorconfig)
- Automatic hooks using Husky/Lintstaged
This was a personal setup, so a few things might not be to your liking. As this is only a template, some things might not be perfect for you, however be free to change things locally and open issues!
After you have setup the project to your liking, there are a few things you should do before getting started!
In the code there are several variables that you have to set before you can get started. All of those are prefixed with <CHANGE_ME:[variable_name]>.
Currently yarn is used as the package manager of my choice in this project. This can obviously be changed; you can even go further and remove the dependencies and node entirely, be aware that the pipeline requires a few dependencies however!
Add your assets to this repository, push the changes and watch as the pipelines build your fonts and assets!