{"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"markdown","__idx":0},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["markdown"]}]},{"$$mdtype":"Tag","name":"ConfigOptionRequirements","attributes":{"products":["Revel","Reef","Realm"],"plans":["Pro","Enterprise","Enterprise+"]},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["markdown"]}," settings are used to customize the behavior and appearance of pages that render from Markdown files."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"options","__idx":1},"children":["Options"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["frontMatterKeysToResolve"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[string]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A list where each entry is a front matter key to resolve at build time."," ","Default: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["['image', 'links']"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["partialsFolders"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[string]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A list of directory paths to folders used for storing partials."," ","All folders other than ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["_partials"]}," must be listed in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["partialsFolders"]}," to work with partials."," ","Default: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["['**/_partials/**']"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["template"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Map file or folder paths or glob patterns to custom page template paths."," ","Use this option to assign templates to Markdown files without adding ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["template"]}," to each file's front matter."," ","Define ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["template"]}," only in the root ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly.yaml"]}," file."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["lastUpdatedBlock"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"#last-updated-object"},"children":["Last updated object"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Configures the \"Last updated...\" string that renders at the top of pages."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["toc"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"#table-of-contents-object"},"children":["Table of contents object"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Controls the page table of contents."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["editPage"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"#edit-page-object"},"children":["Edit page object"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Toggle the appearance of an ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["edit page"]}," button."," ","When clicked, users are directed to the public GitHub repo for the current page."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"last-updated-object","__idx":2},"children":["Last updated object"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["format"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies the format of the last updated time displayed."," ","Possible values: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["iso"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["short"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["long"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["timeago"]},"."," ","Default: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["timeago"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["locale"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Locale of the date."," ","Works with ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://en.wikipedia.org/wiki/ISO_639-1"},"children":["ISO 639-1"]}," country codes."," ","Default: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["en-US"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["hide"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Control the visibility of the last updated time."," ","Default: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"table-of-contents-object","__idx":3},"children":["Table of contents object"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["header"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Configure the heading of the table of contents."," ","Default: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["On this page"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["depth"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Set the maximum depth of the heading displayed in the table of contents."," ","Minimum: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["1"]},"."," ","Default: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["3"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["hide"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Control the visibility of the table of contents."," ","Default: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"edit-page-object","__idx":4},"children":["Edit page object"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["baseUrl"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["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."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["hide"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Control the visibility of the edit page button."," ","Default: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"examples","__idx":5},"children":["Examples"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Define project-level defaults using the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly.yaml"]}," configuration file in your root directory, as in the following example:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","data-title":"redocly.yaml","header":{"title":"redocly.yaml","controls":{"copy":{}}},"source":"markdown:\n  frontMatterKeysToResolve: ['screen-recordings', 'image', 'links']\n  partialsFolders: ['_guide-partials']\n  lastUpdatedBlock:\n    format: long\n    locale: en-US\n  toc:\n    header: Page sections\n    depth: 3\n  editPage:\n    baseUrl: 'https://github.com/Redocly/redocly-cli/tree/main/docs'\n    hide: false\n  template:\n    'blog/**': './@theme/Templates/BlogPost'\n    'blog/drafts': './@theme/Templates/Draft'\n    'demos/new-api.md': './@theme/Templates/SimpleApi'\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When needed, add page-level overrides in the front matter of markdown pages, as in the following example:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"markdown","header":{"controls":{"copy":{}}},"source":"---\nmarkdown:\n  lastUpdatedBlock:\n    hide: true\n  toc:\n    header: Tutorial steps\n    depth: 5\n  editPage:\n    hide: true\n---\n\n# Some amazing guide\n\nAmazing markdown content...\n\n","lang":"markdown"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"resources","__idx":6},"children":["Resources"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/customization/custom-page-templates"},"children":["Customize page templates"]}]}," - Create custom page templates and assign them per file, folder, or glob pattern"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/breadcrumbs"},"children":["Breadcrumbs configuration"]}]}," - Configure page breadcrumbs to improve navigation and user orientation within your documentation"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/links"},"children":["Links configuration"]}]}," - Configure link behavior and styling for consistent navigation and external link handling"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/front-matter-config"},"children":["Front matter configuration options"]}]}," - Use front matter to configure Markdown options on individual pages for granular control"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config"},"children":["Configuration options"]}]}," - Explore other project configuration options for comprehensive documentation customization"]}]}]},"frontmatter":{"products":["Revel","Reef","Realm"],"plans":["Pro","Enterprise","Enterprise+"],"description":"Customize behavior and appearance of pages rendered from Markdown files."},"tagList":["configOptionRequirements","table"],"title":"markdown","lastModified":"2026-10-01T23:00:57.000Z"}