Skip to content

Create and organize a map

Maps define the structure and navigation of your published documentation. Each map is an ordered, nestable collection of topics.

Create a map

  1. Go to Maps in the sidebar.

  2. Click New Map.

  3. Enter a title — e.g., "User Guide" or "API Reference."

  4. Optionally add a description.

Add topics to the map

  1. Click Add Topic in the map editor.

  2. In the picker dialog, search for and select topics.

  3. Topics appear in the map in the order you add them.

You can also add topics from the Topic Pool left panel — click the panel icon to browse all project topics and add them with one click.

Reorder topics

Drag the grip handle on any item to move it up or down in the list.

Use drag-and-drop for quick reordering, and keyboard shortcuts for precise structural changes. Tab indents an item (nests it under the item above), Shift+Tab outdents it. Combining drag-and-drop with keyboard shortcuts is the fastest way to restructure a large map.

Create nested sections

  1. Select a topic in the map.

  2. Click the indent button (or press Tab) to nest it under the item above.

  3. Click outdent (or press Shift+Tab) to move it back up a level.

Nesting creates parent-child relationships. On the published site, parent items appear as expandable sections in the sidebar.

Add section headers

Section headers are map items without an associated topic — they serve as group labels in the navigation.

To create a section header, add a map item and leave it without a linked topic. Give it a descriptive title like "Getting Started" or "Advanced Configuration."

Section headers appear in the published site's navigation sidebar but do not have their own page. Clicking a section header in the sidebar expands or collapses its children. If you want a section to have its own landing page, link it to a topic instead.

Override topic titles

By default, a map item displays the topic's title. To show a different title in this map's navigation:

  1. Click the title text of any map item.

  2. Edit it inline.

  3. The override applies only to this map — the topic's original title is unchanged.

Manage versions

Maps support versioning for maintaining different editions:

  1. In the map editor, click the version label in the header.

  2. Create a new version with a label (e.g., "v2.0").

  3. Each version can use different condition profiles and variable sets when published.

See also

Was this page helpful?