A modern living-template engine for evolving repositories.

---

Check out our Documentation for more information!

• Install
  • Homebrew
  • Binary
  • go install
• Development
  • Prerequisites
  • Building
  • Testing
  • Releasing
  • Building docs
• License

Install

Homebrew

brew install rgst-io/tap/stencil

Binary

Download the latest release from the releases page.

go install

go install github.com/rgst-io/stencil@latest

Development

Prerequisites

Note: If you opt to not use mise, please install all dependencies from .tool-versions manually.

• mise - Ensure that you add the appropriate activations to your shell rc/profiles (details in the mise README)

Install the dependencies:

mise install

Building

mise run build

Testing

mise run test

Releasing

Trigger a new releases by using the Github CLI, or through the Github Actions Workflow UI.

gh workflow run release.yaml

Wait for CI to build and publish the release. You can watch the status by running the following command:

gh workflow view release.yaml --web

Building docs

If you have mise installed, you should have all the tooling you need for the docs engine. Run mise run docsdev from the root stencil directory to enter the watch-rebuild cycle to test your docs changes.

License

Apache-2.0