Customizing Templates

Introduction to Configurable Templates

WarmHub offers the ability to configure templates for data — repositories and types of instance data. Think of this as a dynamic ReadMe. The template represents the surface-level identity of your repository or type of instance data. Templates have access to portions of data you’ve configured or committed to WarmHub.

Each repository ReadMe page has one template, and each type of instance data has one template.

Editing a template

See Template Language Reference for more info

Only owners of repos may edit the templates for that repo. You can access the template editor for both types of templates by visiting their respective pages:

  • For ReadMe Pages, navigate to the ReadMe page of your repo and select “Edit template”

  • For instance data, navigate to the instance datum and select “Edit template”

Clicking the "Edit Markdown" button will allow you to write your own template. Clicking the “Reset to Default” button will pre-populate the template with a default template generated based on the available data.

Clicking the “Reset to Default” button will not delete your previously defined template. To return to your custom template, click the "Edit Markdown" button again.

Once you save the template, it will immediately be applied in the relevant locations.

Default templates

Default templates are generated based on the data available in each context. Please see the specific pages for repository templates and typed instance data templates for more.

Last updated