`markdown`

Products:RevelReefRealm

Plans:ProEnterpriseEnterprise+

The markdown settings are used to customize the behavior and appearance of pages that render from Markdown files.

Options

Option	Type	Description
frontMatterKeysToResolve	[string]	A list where each entry is a front matter key to resolve at build time. By default, values for `image` and `links` are resolved.
partialsFolders	[string]	A list of directory paths to folders used for storing partials. The `_partials` folder works by default, but all other folders must be listed in `partialsFolder` in order to work with partials.
template	object	Map file or folder paths or glob patterns to custom page template paths. Use this option to assign templates to Markdown files without adding `template` to each file's front matter. Define `template` only in the root `redocly.yaml` file.
lastUpdatedBlock	Last updated object	Configures the "Last updated..." string that renders at the top of pages.
toc	Table of contents object	Controls the page table of contents.
editPage	Edit page object	Toggle the appearance of an edit page button. When clicked, users are directed to the public GitHub repo for the current page.

Last updated object

Option	Type	Description
format	string	Specifies the format of the last updated time displayed. Possible values: `iso`, `short`, `long`, or `timeago`. Default value: `timeago`.
locale	string	Locale of the date. Works with ISO 639-1 country codes. Default value: `en-US`.
hide	boolean	Control the visibility of the last updated time. Default value: `false`.

Table of contents object

Option	Type	Description
header	string	Configure the heading of the table of contents. Default value: `On this page`.
depth	integer	Set the maximum depth of the heading displayed in the table of contents. Default value: `3` Minimum value: `1`.
hide	boolean	Control the visibility of the table of contents. Default value: `false`.

Edit page object

Option	Type	Description
baseUrl	string	Set the base URL that the page's path is appended to. The link should direct users somewhere to submit an edit, for example a public GitHub repo.
hide	boolean	Control the visibility of the edit page button. Default value: `true`.

Examples

Define project-level defaults using the redocly.yaml configuration file in your root directory, as in the following example:

redocly.yaml

markdown:
  frontMatterKeysToResolve: ['screen-recordings', 'image', 'links']
  partialsFolders: ['_guide-partials']
  lastUpdatedBlock:
    format: long
    locale: en-US
  toc:
    header: Page sections
    depth: 3
  editPage:
    baseUrl: 'https://github.com/Redocly/redocly-cli/tree/main/docs'
    hide: false
  template:
    'blog/**': './@theme/Templates/BlogPost'
    'blog/drafts': './@theme/Templates/Draft'
    'demos/new-api.md': './@theme/Templates/SimpleApi'

When needed, add page-level overrides in the front matter of markdown pages, as in the following example:

---
markdown:
  lastUpdatedBlock:
    hide: true
  toc:
    header: Tutorial steps
    depth: 5
  editPage:
    hide: true
---

# Some amazing guide

Amazing markdown content...

Resources

Override a page template - Create custom page templates and assign them per file, folder, or glob pattern
Breadcrumbs configuration - Configure page breadcrumbs to improve navigation and user orientation within your documentation
Links configuration - Configure link behavior and styling for consistent navigation and external link handling
Front matter configuration - Use front matter to configure Markdown options on individual pages for granular control
Configuration options - Explore other project configuration options for comprehensive documentation customization

markdown