Insert component references
A How component reuse works reference embeds a component's content into a topic. The content stays in sync with the source.
Before you begin
Create reusable components in your project
Open a Create and manage topics where you want to insert the reference
Insert a block-level reference
Open a topic in the editor.
Place your cursor where you want the component.
Type
/and select Component from the Editor slash commands.In the picker dialog, search for the component by name and select it.
The component's content appears as an inline block with a subtle border.
Block-level references work best for standalone content like disclaimers, prerequisite lists, or contact blocks. They occupy their own space in the topic layout, separated from surrounding paragraphs.
Insert an inline reference
For smaller fragments that sit within a paragraph:
Place your cursor inside a line of text.
Type
/and select Inline Component.Search and select the component.
The component content renders inline, flowing with the surrounding text.
Inline references are ideal for short, reusable fragments like product names, version numbers, or standard phrases that appear mid-sentence. For longer content blocks, use block-level references instead.
Identify references in the editor
Component references show a subtle border and a small component icon. Hover over a reference to see the component name. Click the icon to open the source component for editing.
How references update
When you edit a component's source content, every topic containing a reference to that component reflects the change the next time it loads. No manual action is needed — references are How component reuse works.
Component references are read-only in the topic editor. To change the content, you must open the source component directly. This prevents accidental edits that would affect all referencing topics.
See also
How component reuse works — the conceptual model behind live references
Create reusable components — create the components you need before inserting references
Editor slash commands — full reference for the `/` menu including component insertion
Reuse content with components — end-to-end tutorial covering the full component workflow