Skip to Content
API DocumentLogo, Links and Footer

Logo, Links, Footer and Banner

A published document can carry your own logo and favicon, links to your other sites, a footer and an announcement banner. Set them in Publish Center → API & Documents → Setting, in the Branding, Navbar, Footer and Banner panels of the site settings. They apply to every published version, and nothing is added to your repository.

A site that sets none of them looks as it did before: nothing is added.

A published page with a logo, header links, a banner and a footer

Logo and favicon

There are two kinds of logo:

  • The square logo is shown beside the document name.
  • A wide logo replaces the square logo and the name. You can add a second image for dark mode and a link the logo leads to.

The favicon is the icon of the browser tab.

All of them are uploaded in the Branding panel:

The Branding panel with a wide logo, a logo for dark mode and a favicon

FieldWhat it doesRule
Square logoShown beside the document name when no wide logo is setJPEG or PNG, at most 64 x 64 pixels. Saved as soon as it is uploaded
Wide logoReplaces the square logo and the name in the headerAn image, see below
Logo in dark modeUsed when the page is dark. Empty: the wide logo in both modesAn image. Needs a wide logo
Logo linkWhere a click on the logo leads. Empty: the first page of the siteAn https:// address or a page of the site. Needs a wide logo
FaviconThe browser tab iconAn image

To set an image, click Upload image and choose a file. The panel shows it at once; click Save to put it on the site. Replace uploads another file, and Remove followed by Save takes the image off the site.

An image is an SVG, PNG, WebP, JPG or ICO file of at most 500 KB. An SVG file must stand on its own: one that contains a script, or that refers to a font, stylesheet or picture outside the file or embeds a picture, is refused, and the panel tells you why.

The wide logo is drawn 28 pixels high.

Readers whose device is in dark mode see a dark page by default. If your logo is dark artwork, add a Logo in dark mode, or set Appearance to Light.

Add up to six links and one button, for example to your product, blog or sign-up page.

  • In the Clover theme they are at the right of the top bar.
  • In the other themes they are at the foot of the sidebar: the button first, then the links.
  • On a phone they are in the navigation drawer.

In the Navbar panel:

FieldRule
ButtonOne highlighted link, such as “Get started”: a label and an address
LinksUp to six, shown in the order of the list. Each has a label and an address

An address is an https:// or http:// address, a mailto: address, or a page of the site (a path in the repository, such as changelog.md). A link to another site opens in a new tab. A label has at most 40 characters.

The footer is shown under a Markdown page, below the previous and next links. It is not shown on API reference pages.

In the Footer panel:

FieldRule
TextOne line, such as a copyright notice. At most 200 characters
LinksUp to twelve, with the same rules as header links
Social linksGitHub, X, LinkedIn and YouTube; each an https:// address of your profile

Announcement banner

A banner is one line across the top of every page, in your brand colour.

In the Banner panel:

FieldRule
Show the bannerTurns the banner on or off. Switching it off keeps the text for later
ContentAt most 200 characters. It may use **bold** and [links](address), for example **v2** is out. [Read the notes](changelog.md)
DismissibleWith Readers can dismiss it, a reader can close the banner; it stays closed for them until you change its text

On a phone a long banner is cut after two lines.

Last updated on