Write topics, build a map, publish to the web

By the end of this tutorial, you will understand the full authoring workflow: creating Create and manage topics with rich formatting, organizing them in a hierarchical Create and organize a map, and publishing a polished documentation site.

What you will build #

A 5-topic user guide with nested sections, formatted content (tables, code blocks, callouts), and a published site with 2 levels of navigation depth.

Before you begin #

• Complete the Create your first help site in 10 minutes tutorial or have an existing Topicary project

• Familiarity with the project dashboard and sidebar navigation

Create a project #

1. From the Projects page, click Create project and name it "Acme Docs."

2. You land in the project dashboard.

Write a welcome topic #

1. Go to Topics and click Create topic.

2. Title it "Welcome to Acme."

3. Write an introductory paragraph.

4. Type / and select Info Callout. Inside the Add callouts, write a note like: "This documentation covers Acme version 3.0."

5. Below the callout, add a Heading 2 called "What is covered" and a bullet list summarizing the sections readers will find.

Write a setup topic #

1. Create another topic called "Installation and Setup."

2. Add a Heading 2 for "System Requirements" and insert a Work with tables with columns for Component, Minimum, and Recommended.

3. Add a Heading 2 for "Install steps" and write numbered steps.

4. Add a code block (type / then select Code Block). Set the language to bash and write an install command.

5. Below the code block, add a Warning Callout noting a common pitfall during installation.

Write 3 more topics #

Create these topics with any content you like:

• "Basic Usage": describe the core workflow with a mix of paragraphs and lists

• "Configuration Reference": use a table listing all configuration options, their types, and defaults

• "Troubleshooting": add a few Heading 2 sections, each describing a problem and solution

Set topic statuses #

1. Open each topic and find the Content statuses control in the Properties panel (open it from the right icon rail).

2. Change "Welcome to Acme" and "Installation and Setup" to Published.

3. Leave the others as Draft for now.

Build a map with nesting #

1. Go to Maps and create a map called "Acme User Guide."

2. In the map editor, add all 5 topics in order by clicking them in the Topic Pool panel on the left.

3. Nest "Installation and Setup" under "Welcome to Acme": drag it slightly to the right, or right-click it and choose Indent.

4. Leave "Basic Usage," "Configuration Reference," and "Troubleshooting" at the top level.

Your map now has 2 levels: "Welcome to Acme" with a child page, and 3 standalone pages.

Publish and review #

1. Open the Publishing panel from the map editor's right icon rail and click Set up publishing.

2. Add a Web Publication target settings called "Acme Help Center" with Add target, then click Publish.

3. Open the published site.

Notice how the sidebar reflects your nesting: "Welcome to Acme" has an expandable section with "Installation and Setup" underneath. Each page shows its headings in the right-side table of contents.

What you learned #

• Topics are atomic: each one covers a single subject

• The editor supports rich Format content in the editor through Use slash commands and the toolbar

• Statuses track content readiness but do not affect what gets published (the output includes all map topics)

• Maps define navigation hierarchy through indentation

• Publishing converts your map into a complete site with search, navigation, and a table of contents

Next: Reuse content with components to eliminate duplication across topics.

See also #

• Create and manage topics: detailed guide to topic creation and management beyond this tutorial

• Create and organize a map: advanced map features like versioning and reordering

• The publishing pipeline: what happens behind the scenes when you click Publish

• Keyboard shortcuts: speed up your authoring workflow