Front Matter Headers

Basic Usage

title: Installation Guide
author: John Doe
description: Step-by-step installation instructions
keywords: install, setup, configuration
date: 2024-01-15

# Installation Guide

Your content here...

Metadata Headers

Configuration Headers

All configuration options^[1] can be set per-page via frontmatter. Frontmatter takes precedence over site.xml settings.

buildIndex: false
convertImagesToWebp: false
syntaxHighlighting: false

# My Page

Content here...

See the Configuration Reference^[1] for the complete list of available settings.

Examples

buildIndex: false
buildAiIndex: false

# Internal Notes

This page won't appear in search or AI indexes.

convertImagesToWebp: false
convertImagesToThumbnails: false

# Raw Images

Images stay in original format without zoom.

interpolation: velocity

# Dynamic Page

This page uses Velocity: $project.version

AngularJS Content

By default, protectAngular: true keeps {{...}} expressions literal in document text, including code examples, headings, the table of contents, and skin-rendered labels such as menus, breadcrumbs, site titles, banner names, and versions. Generated banner image alt text is protected too. This allows Go, Helm, and other template examples to display and copy unchanged while the skin's search, tabs, image zoom, and other interactive features still work.

Pages that intentionally use AngularJS text bindings must opt out:

title: Interactive Page
protectAngular: false

# Interactive Page

<p>{{1 + 2}}</p>

<meta name="protectAngular" content="false" />

You can also set a site-wide default with <protectAngular>false</protectAngular> inside site.xml's <custom> section. Page metadata takes precedence, so protectAngular: true can protect individual pages on that site. Existing pages that use AngularJS bindings need this opt-out when upgrading.

Protection is applied when the site is built and targets text and code, rather than arbitrary HTML attributes or author-supplied AngularJS directives. Literal textarea and inline style content is also protected; directives on the containing elements, such as ng-model and copy buttons on code, remain active. It does not sanitize scripts. The separate interpolation setting controls Maven/Velocity ${...} expressions.

How It Works

Headers are processed in two ways:

1. Metadata headers (title, author, description, keywords) are added to the HTML <head>:

   <meta name="author" content="John Doe">
   <meta name="description" content="Step-by-step installation...">
   <meta name="keywords" content="install, setup, configuration">
   

2. Configuration headers control how the page is processed by the skin.

Tips

See Also

• Configuration Reference^[1] - All configuration options
• Maven Properties^[2] - Property interpolation modes