Skip to content

Create reusable components

Components are content fragments you write once and reference from any Create and manage topics. Updating a component updates every reference.

Before you begin

Create a component from scratch

  1. Go to Components in the sidebar.

  2. Click New Component.

  3. Enter a name that describes the content — e.g., "Legal Disclaimer" or "Support Contact."

  4. Write the content in the editor. Components support the same formatting as topics: text, lists, tables, callouts, code blocks.

  5. The component auto-saves.

Use specific, descriptive names for components. "Legal Disclaimer" is better than "Disclaimer" — clear names make components easier to find in the Editor slash commands when inserting references.

Create a component from existing content

  1. Open a topic in the editor.

  2. Select the text you want to reuse.

  3. In the floating toolbar, click the Puzzle icon (Save as Component).

  4. Enter a name for the component.

  5. The selected content is extracted into a new component. The original location is replaced with a Insert component references to it.

Extracting a selection as a component is non-destructive to the topic's visible content. The reader sees the same text — but now it's sourced from the component rather than stored locally in the topic.

Edit a component

  1. Go to Components and click the component to open it.

  2. Edit the content in the editor.

  3. Changes propagate to every topic that references this component.

Before editing a widely-used component, check the where-used count on the Components page. Changes propagate to every referencing topic instantly. For components used in 10+ topics, consider reviewing the impact before making significant edits.

Delete a component

  1. Open the component.

  2. Click the three-dot menu and select Delete.

  3. If the component has active references, a warning shows the reference count. Deleting a component with active references creates broken references in those topics.

Deleting a component with active references cannot be undone. The references in affected topics will break and need to be manually replaced with local content. Always check the reference count before deleting.


See also

Was this page helpful?