meta

Usage

Use the meta section to control the contents of your portal's HTML <head> element.

Add it to the top level of the siteConfig.yaml file and configure supported options inside it. Some of the options can be used in the front matter of MD(X) pages to override the site-wide configuration.

Options

Option Description Front matter
description Sets the contents of the <meta name="description"> tag in your portal. The description should be up to 150 characters long. This text may be used for your portal in search engine results pages. ✔️
image Sets the rich metadata image that is used when sharing links to your portal on social media. You must provide the path to an existing image in your portal project. ✔️
keywords Sets the contents of the <meta name="keywords"> tag in your portal. Provide the keywords as a comma-separated list, e.g. keywords: documentation, api, openapi. ✔️
lang Sets the language attribute for your portal to indicate the language in which the content is written. Provide the lang value as a language tag with optional subtags (for example, en-US for United States English, es for Spanish). Consult the W3.org guide and the language subtag registry for more information about language tags and subtags. ✔️
siteUrl Sets the base URL for canonical links in your portal. When this option is configured, it automatically adds rel="canonical" to the head of all HTML pages in your portal.
title Sets the default contents of the <title> tag in your portal. This title is used for your portal in search engine results pages, and when sharing links to your portal on social media. The title set here is appended to page titles (e.g. for title: Redocly, it's "Page title - Redocly"). When a page doesn't have a defined title, the title set here is used as a fallback. ✔️
logoAltText Sets the alternative text (alt attribute) for the logo image. Use this option to create a description of the logo image that will be used by assistive technologies such as screen reader software. The text specified here is also displayed in place of the logo image when it's missing or when it can't be loaded. ❌️
logoHref Sets the URL the logo icon is pointing to. ❌️

Examples

In siteConfigIn front matter
meta:
  title: Example Developer Portal
  description: Learn how to work with Example APIs
  siteUrl: https://www.example.com
  image: .images/example-portal-home.png
  keywords: 'documentation, api, portal'
  lang: en-US
  logoAltText: alt text for logo
  logoHref: https://www.example.com
---
title: Example Markdown page
description: GitHub-flavored Markdown example
image: .images/example-page.png
keywords: 'markdown, github'
lang: en-US
---

Example text