As far as I can tell the different formats are built and committed to the dist folder. While the zip files are not very large, this has a few negative effects:
- It makes upgrading your documentation from the template unnecessarily cumbersome (check the website or repo for a specific new zip, unpack, check contents...)
- It increases the repo size unnecessarily / dramatically with each new release
- You can't use a simple command / API to check if you are still using the latest template
Please consider using Git tags and GitHub Releases (or whatever equivalent service you might use in the future, they likely all have such a feature today) to publish release artifacts and announce new versions.
On second thought, using this repo as a git submodule with symlinks would make the process of keeping documentation in line with the upstream template simpler than fetching and unpacking zips. Tagging new template releases would also be a benefit with this approach and be "API native".
Let me know if you need help or a PR.
As far as I can tell the different formats are built and committed to the
distfolder. While the zip files are not very large, this has a few negative effects:Please consider using Git tags and GitHub Releases (or whatever equivalent service you might use in the future, they likely all have such a feature today) to publish release artifacts and announce new versions.
On second thought, using this repo as a git submodule with symlinks would make the process of keeping documentation in line with the upstream template simpler than fetching and unpacking zips. Tagging new template releases would also be a benefit with this approach and be "API native".
Let me know if you need help or a PR.