Styles, Branding and Design Tokens

A style defines how a public documentation site looks: its colors, fonts, logos, top bar, footer and texts. This page explains each part. A style is assigned to a domain; several domains can share one.

Roles: Only an admin manages styles and palettes. It needs the publish license feature. See License and Tiers.

Create a style#

Open Publishing → Styles and brands and click Add style. A style has a name and the sections below. A domain without a style uses the Default look, which is the Ocean preset.

A style that a domain uses cannot be deleted, and neither can a palette that a style uses. The message names the domains or styles in the way.

Colors and style#

Choose where to start from:

  • Presets. Five ready-made, balanced sets with a light and a dark scheme: Ocean (the default), Forest, Violet, Sunset and Graphite.
  • Saved palettes. Your own sets. Several styles can refer to one palette, so editing the palette changes all of them after a confirmation. Use Save as palette, Save changes to the palette, Rename palette and Delete palette.

On top of the chosen source, any parameter can be overridden. A style stores only the differences, and Reset to the preset value removes an override. Colors are set separately for the light and dark scheme; the reader's theme setting picks which one is shown.

Group Parameters
Page Page background, panels, code background, text, secondary text, borders
Accent Accent (links and buttons), text on accent
Header and footer Header and footer background and text, top bar and footer links, links on hover
HTTP methods GET, POST, PUT, PATCH, DELETE
Response statuses 2xx, 4xx, 5xx
Typography and layout Font, font size, corner radius, density, content width

Allowed values:

Parameter Values
Colors #rrggbb or #rrggbbaa only
Font System, Inter, Roboto, Source Sans, Serif (a fixed list)
Font size 13–20 px
Corner radius None, Small, Medium, Large
Density Compact, Normal
Content width 880–1800 px

Nothing else is accepted: no URLs, no functions and no free-form CSS. Fonts are chosen by key, and the portal maps the key to its own font stack. When a text and its background have a low contrast, the editor shows advice with the measured ratio; 4.5:1 is recommended. The advice does not block saving.

Images#

Image Notes
Top logo Shown in the top bar. Can link somewhere when clicked.
Bottom logo Shown in the footer, with its own link.
Favicon PNG, JPEG, WebP or ICO.

Pictures are PNG, JPEG or WebP, up to 1 MB and up to 4096 px on a side. SVG is never accepted. A new style is saved when you upload its first picture.

Top bar#

  • Height: 40–120 px, 64 by default.
  • Links: up to 10, shown in one line in the order of the list. Reorder them with Move up and Move down.

The footer builder offers:

  • a text next to the bottom logo (up to 300 characters);
  • up to 6 blocks, each with a title (up to 60 characters) and up to 10 links;
  • a copyright line (up to 200 characters), where {year} is replaced by the current year;
  • up to 10 links on the right of the bottom row.

A link has a text of up to 60 characters and an address of up to 500 characters. An address must start with http://, https:// or mailto:; anything else is refused.

The links of the top bar and of the footer have their own colors (normal and on hover, light and dark scheme). Separately for each of the two bars, and separately for the normal state and for the moment the pointer is over a link, you can set:

Parameter Values
Underline On hover, Always, None
Font weight Normal, Medium, Bold
Font size 12–24 px

Site texts and languages#

  • Site name and default description, used in the title and in search results.
  • Languages, comma separated, for example en, ru. The portal offers a language switcher when there is more than one.
  • Default language.

The texts of the portal's interface come from SelfDocHub's interface translations, so a translation you edit there appears on the public site too. See Interface Translations.

Next steps#

Screenshots

Last updated: