Skip to content

Publication target settings

Each publication target is configured with the following settings.

Setting

Description

Required

Name

Display name for the target

Yes

Output format

Web or PDF

Yes

Filter profile

Which filter values to include (for example, Audience: Admin)

No

Variable set

Which variable set to use for token substitution

No

Variable overrides

Per-target value overrides for specific variables

No

Homepage

Which topic serves as the site homepage

No

Subdomain

Subdomain for the published URL

Web only

Custom domain

Custom domain for the published site (Team)

Web only

Access mode

Public or password-protected (Team)

Web only

SEO

Title template, description, language, and noindex

Web only

Locale

Language of this target, for multi-locale publishing (Enterprise)

No

Search

Search backend configuration (Enterprise)

Web only

PDF layout

Page size, margins, cover, table of contents, headers and footers

PDF only

Filters were previously called "conditions." The app UI labels the feature Filters and a dimension a filter group. Filters are an Enterprise-tier capability; variables are a Team-tier capability.

Filter profile

A JSON object mapping filter-group names to arrays of values:

{ "Audience": ["Admin"], "Platform": ["Web", "Mobile"] }

Content wrapped in filtered blocks is included only if the block's group and value match the profile.

An empty filter profile (or no profile at all) includes all content regardless of filters. If you leave the profile blank, every filtered block appears in the output. There is no "exclude everything" default.

Example profiles for common scenarios:

// Admin web docs: only Admin audience, Web platform
{ "Audience": ["Admin"], "Platform": ["Web"] }

// End-user docs: all platforms
{ "Audience": ["End User"], "Platform": ["Web", "Mobile", "Desktop"] }

// Internal docs: multiple audiences, single platform
{ "Audience": ["Admin", "Developer"], "Platform": ["Web"] }

Variable set

Select a variable set from the project's defined sets. All variable tokens in the content resolve to values from this set.

Variable overrides

Key-value pairs that override specific values from the selected variable set. Useful for changing one or two values without creating a separate set, for example overriding api_base_url for a staging target.

{
  "api_base_url": "https://staging-api.example.com",
  "support_email": "staging-support@example.com"
}

Variable overrides take precedence over the variable set. If the same key exists in both the set and the overrides, the override value wins. Keys in the override that do not exist in the set are ignored.

Homepage

Choose which topic serves as the site homepage. Readers land on this topic at the site root. If you do not set one, the site shows a homepage card grid of top-level topics.

Subdomain and custom domain

Every web target is served at subdomain.topicary.com. You choose the subdomain when you create the target.

A custom domain (for example, docs.example.com) is a Team-tier capability. Adding one registers it with the hosting provider and, once verification completes, serves the site at your own domain.

Access mode

Web targets are public by default: anyone with the URL can read them. Setting the access mode to password protects the site behind a shared password. Password protection is a Team-tier capability. Changing the password immediately signs out existing readers.

SEO

Web targets carry SEO settings: a title template, meta description, site language, and a noindex toggle. These drive the meta tags, sitemap, and structured data emitted for the published site.

Publishing states

State

Description

URL behavior

Published

Site is live and accessible at its URL

Returns site content

Unpublished

Site is offline

URL returns no content

Toggle between states by clicking Publish or Unpublish on the target.

See also

Was this page helpful?