Skip to content

Use topic templates

Templates let you save a topic's content and structure as a reusable starting point. Create new topics from a template to maintain consistency across your documentation. Templates are available on every plan.

There is no built-in template catalog. Every template starts from one of your own topics through Save as template.

Save a topic as a template

  1. Open the topic you want to use as a template.

  2. Open the Properties panel in the right sidebar.

  3. Click Save as template.

  4. Enter a title for the template, for example, "API endpoint reference" or "How-to guide."

  5. Optionally add a description explaining when to use this template.

  6. Click Save.

The template captures the topic's current content, structure, and formatting. It does not include metadata like status, tags, or branch information.

Any existing topic can be saved as a template the same way. There is no separate "template" object you have to start from.

Design templates with placeholder text that is easy to identify and replace. For example, use "[Product name]" or "[Feature description]" so authors know what to fill in.

Create a topic from a template

  1. Click Create topic on the Topics page.

  2. If templates exist, a template picker appears with two phases:

    • Search and browse: filter templates by name or scroll the list.

    • Name and create: enter a title for the new topic and click Create.

  3. The new topic opens in the editor with the template's content pre-filled.

When no templates exist yet, the template picker skips the search step and goes straight to naming the new topic.

Creating a topic from a template copies the template's content. There is no ongoing link: changes to the template do not affect topics created from it, and vice versa.

Manage templates

Templates are project-scoped. Any Author or Admin can create, use, and delete templates.

To delete a template:

  1. Click Create topic on the Topics page to open the template picker.

  2. Find the template in the list and open its kebab menu (3 dots) on the right of the row.

  3. Click Delete and confirm.

Deleting a template does not affect topics that were created from it.

See also

Was this page helpful?