Use variables

Use {{...}} references to insert configured and built-in variables into authored Markdown. Variables can render text or links.

Reference variables

Use {{name}} or a dotted path such as {{company.name}} in Markdown text:

markdown
# {{documentation_title}}

{{product_name}} is maintained by {{company.homepage}}.

DocInsight expands variables in paragraphs, headings, lists, tables, and TOC labels. A link-valued variable renders as a link.

Objects cannot be rendered directly; reference one of their renderable fields instead. The value of project.name does not define another variable.

Variables do not expand inside inline code, fenced code blocks, raw HTML, or Markdown link destinations. Prefix the opening braces with a backslash to write a literal reference, such as \{{product_name}}.