Typemark Documentation

Branding

Set your site's accent color, logo, and favicon, and see how light and dark mode work.

Uuendatud 19. nov 20262 min lugemist

Your site's look comes from three settings: a primary color, a logo, and a favicon. Set the first two in Settings > Look and feel; the favicon lives in typemark.json.

Primary color

The primary color is your accent: links, the active sidebar item, focus rings, and highlights. Pick a swatch or enter any hex value under Brand colour in Settings > Look and feel, or set it in typemark.json. The preview beside it shows your site in the new color before you save:

"colors": {
  "primary": "#3b82f6"
}

Use a hex value. Sites without a primary color use #4f46e5.

When the color is used for text, such as links, Typemark darkens or lightens it as needed to keep at least 4.5:1 contrast against the background, in both light and dark mode.

The logo sits in the top-left corner of the site header, 28 pixels tall and up to 160 pixels wide. Add a light-mode and a dark-mode version so it stays visible in both themes.

Go to Settings > Look and feel and upload files under Logo and Logo for dark mode. PNG, JPEG, GIF, SVG, and WebP work. Typemark saves the files to your repo's images/ folder and updates typemark.json.

Add the files to your repo, then point to them. Paths are relative to the repository root; full https:// URLs work too.

"logo": {
  "light": "/images/logo-light.svg",
  "dark": "/images/logo-dark.svg"
}
  • One version only? Set either key and Typemark uses it in both themes.
  • No logo? The header shows the first letter of your project name in your primary color, followed by the name.
  • Broken path? If the image doesn't load, the header falls back to the project name.

SVG stays sharp at every size. A wide, horizontal logo fits the header best.

Favicon

Set the browser tab icon in typemark.json. Use a square image.

"favicon": "/images/favicon.png"

Light and dark mode

Every Typemark site has a light and a dark theme, and a toggle in the header to switch between them. The site follows the reader's system setting until they pick a theme, and their choice is saved in their browser.

In dark mode, the logo switches to your dark file and code blocks use a dark theme.

Coming soon page

While your site is offline, visitors see a "Documentation coming soon" page with your logo and primary color. See Publishing.

Page not found

When a reader opens a page that doesn't exist on your site, for example through an old link, they get your site's own "That page doesn't exist" page. It has your site's name, logo, favicon, primary color, navigation, footer, and custom CSS, with links to your first few pages and back to the docs. Search engines are told not to index it.

Remove "Powered by Typemark"

Free sites show a "Powered by Typemark" line at the bottom of each page. On Pro and Enterprise, turn on Hide Typemark branding in Settings > Reader features, or set "hide_branding": true under features.