Skip to content
Tenzir

Documentation

The Tenzir documentation resides at https://github.com/tenzir/docs. We use Astro with Starlight as website framework.

Develop and view locally

Section titled “Develop and view locally”

Install web framework dependencies:

Terminal window
pnpm install

Build a development version of the docs:

Terminal window
pnpm dev

Then browse to http://localhost:4321/ to view the site.

Build for production

Section titled “Build for production”

Create a production build as follows:

Terminal window
pnpm build

Preview the generated files by spinning up a web server:

Terminal window
pnpm preview

Then browse to http://localhost:4321/ to view the site.

We create a production build in CI. Check out our GitHub workflow for the gory details.

Edit diagrams

Section titled “Edit diagrams”

We use Excalidraw as primary tool to create sketches of architectural diagrams.

When exporting Excalidraw scenes, always use light mode and choose SVG as export format, as we have some CSS magic in place that automatically inverts colors SVGs so that they also look nicely when using dark mode.

Tenzir developers have access to our Exalidraw Documentation collection. For everyone else, we encourage to reach out to us on our Discord server to request changes to existing SVGs.