Documentation

    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

HDocBook Frontmatter

In the HDocBook system, within each article you can include additional metadata that describes author details, options for how the content should be rendered, its index, its inclusion in any taxonomy, keywords, and more. The additional metadata, called frontmatter, is used to provide this information to the HDocBook publishing system without rendering it as part of the article.

Frontmatter Content Example

Frontmatter content is actually expressed in another language called YAML, so this is really a language within another language. At least, this is how the processing tools see it.

By way of an example, here is a simple Markdown document with a H1 header and a paragraph:

# The Document Title

Some article paragraph text....

And here is that same article, but now with two metadata properties, title and layout, so now the document looks like this:

---
title: Doc Title
layout: article
---
# The Document Title

Some article paragraph text....

Frontmatter must always appear at the top of the article. The frontmatter content is fenced between two lines of three or more hyphens (—). The beginning and end of the frontmatter content block appear between these two fence lines. The Markdown parser will not directly render any of the frontmatter data or enclosing fence guards; Markdown rendering starts from the first text line after the second (—) Markdown fence line.

Frontmatter Metadata Properties

Property Description
title The title of this document; typically, but not always, the same as the first H1 in your document.
status The status of this document. Currently supports values of draft and release. When an article is set to draft, the content will be excluded from the Hornbill Docs site map, and therefore won’t be picked up by any web crawlers, but the content will still be accessible via its docs.hornbill.com path. NOTE: The frontmatter status property is also set on articles that are marked as draft in the Navigation Item Properties, either directly or from one of the items parents, during the build of a book
layout The layout template to use when rendering this document. If not specified, this defaults to “article”. Click here for a list of Content Layout Templates.
coverImage Fully qualified [options] path from root for an image used as a cover image. This will be used for gallery rendering and social sharing, using the Open Graph protocol. If not specified, the book-specific image will be used, and if not defined at book-level a global generic image will be used.
description A description of the document. This will be used for gallery rendering and social sharing, using the Open Graph protocol. If not specified, a description will be generated using the first line of the book content.
readingTime The amount of reading time required for this document. If not specified, this will be calculated automatically when the document is built, ready for publishing.
pdfAvailable Set to ‘true’ if there is a PDF document available for this article.
keywords A list of keywords associated with the article to enhance its relevance in documentation search rankings.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document