Project properties
Use project.* to access configuration values from your retype.yml file. This keeps your content in sync with project settings and avoids hardcoding values that might change.
For page-level metadata, see Page properties.
Basic usage
Welcome to {{ project.branding.title }}!If your retype.yml contains:
branding:
title: My DocumentationOutput:
Welcome to My Documentation!Common properties
Accessing links
The links property is an array. Loop through all links:
{{ for link in project.links }}
1. {{ link.text }}
{{ end }}Output:
- What's New
- Pro Pricing
- Support
- Social
Or access individual links by index:
First link: {{ project.links[0].text }}
Third link: {{ project.links[2].text }}Output:
First link: What's New
Third link: SupportEscaping template syntax
Inline escaping
To display literal {{ }} syntax without the template engine processing it, wrap the content in opening {%{ and closing }%} escape tags:
{%{ {{ page.title }} }%}This is useful when documenting template syntax or showing code samples that include double curly braces.
Page-level escaping
To disable templating for an entire page, set templating: false in the page settings:
---
templating: false
---Project-level escaping
To disable templating project-wide, update your retype.yml with the following:
templating:
enabled: false