{"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"supported-markdown-features","__idx":0},"children":["Supported Markdown features"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"danger","name":"Deprecated docs"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The developer portal beta is ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/product-timelines"},"children":["approaching end of life"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use Realm and Reunite instead. Read the ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs-legacy/developer-portal/migrate-from-legacy-portal"},"children":["migration guide"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When creating pages in your developer portal, use ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://github.github.com/gfm/"},"children":["GitHub-flavored Markdown"]},". All standard text formatting options (emphasis, inline code...), multimedia (inserting images and videos), and page elements (links, tables, code and quote blocks, lists, headings...) are supported."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This page highlights some of the special Markdown features you can use in your portal pages."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"front-matter","__idx":1},"children":["Front matter"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["By adding front matter to a Markdown page, you can set per-page options and override some of the site-wide portal settings. Front matter must be at the beginning of a Markdown file, in valid YAML format between triple-dashed lines (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["---"]},")."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"md","header":{"controls":{"copy":{}}},"source":"---\nseo:\n title: Markdown example\n description: GitHub-flavored markdown example\ntoc:\n enable: true\n maxDepth:\n---\n","lang":"md"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"supported-front-matter-options","__idx":2},"children":["Supported front matter options"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"disablelastmodified","__idx":3},"children":["disableLastModified"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},", hides the \"Last updated {time} ago\" label at the top of the page."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"md","header":{"controls":{"copy":{}}},"source":"---\nseo:\n title: Markdown example\ndisableLastModified: true\n---\n","lang":"md"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"editpage","__idx":4},"children":["editPage"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Configures the appearance of the edit page button when it's enabled in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["siteConfig.yaml"]},"."]},{"$$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":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["disable"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},", hides the button on the page."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["baseUrl"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["URL of the root folder of your GitHub or GitLab project."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["text"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Text to display on the edit button."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["icon"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Path to the image file (svg or png) used as the button icon."]}]}]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"md","header":{"controls":{"copy":{}}},"source":"---\nseo:\n title: Markdown example\neditPage:\n disable: true\n---\n","lang":"md"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"exclude","__idx":5},"children":["exclude"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},", excludes the page from the portal build. To prevent broken links or potential build failures, make sure to remove any entries for the excluded page from your ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sidebars.yaml"]}," file. If other MD or MDX pages have links pointing to the excluded page, you should remove or modify them prior to building the portal."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"md","header":{"controls":{"copy":{}}},"source":"---\nseo:\n title: Markdown example\nexclude: true\n---\n","lang":"md"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"excludefromsearch","__idx":6},"children":["excludeFromSearch"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},", the page is excluded from the search index and is not accessible from the search results."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"md","header":{"controls":{"copy":{}}},"source":"---\nseo:\n title: Markdown example\nexcludeFromSearch: true\n---\n","lang":"md"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"permission","__idx":7},"children":["permission"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Used with the ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs-legacy/developer-portal/configuration/rbac"},"children":["RBAC feature"]}," to set per-page access permissions."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"redirectfrom","__idx":8},"children":["redirectFrom"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Defines one or more URLs that are redirected to the URL of the Markdown page. Each URL must be provided as an item in an array with a trailing slash at the end. Read more about ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs-legacy/developer-portal/guides/redirects"},"children":["using redirects"]},"."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"md","header":{"controls":{"copy":{}}},"source":"---\nseo:\n title: Markdown example\nredirectFrom:\n - /docs/example-portal/markdown/\n - /docs/example-portal/test/\n---\n","lang":"md"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"requestlogin","__idx":9},"children":["requestLogin"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When using a custom login component in the portal, setting this to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," redirects to the portal login page if the user is not already logged in."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"seo","__idx":10},"children":["seo"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Controls the contents of your portal's HTML ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[""]}," element."]},{"$$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":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["description"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sets the contents of the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[""]}," tag for the page. The description should be up to 150 characters long. This text may be used for the page in search engine results pages."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["image"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sets the rich metadata image that is used when sharing the link to the page on social media. You must provide the path to an existing image in your portal project."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["jsonLd"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Configures ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://json-ld.org/"},"children":["JSON-LD"]}," parameters for the page. Individual per-page configuration in the front matter has priority over general configuration in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["siteConfig.yaml"]},". The JSON-LD script is rendered within ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[""]}," only when you configure JSON-LD - it is not rendered by default."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["keywords"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sets the contents of the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[""]}," tag for the page. Provide the keywords as a comma-separated list, e.g. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["keywords: documentation, api, openapi"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["lang"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sets the language attribute for the page to indicate the language in which the content is written. Provide the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lang"]}," value as a language tag with optional subtags (for example, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["en-US"]}," for United States English, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["es"]}," for Spanish). Consult the ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://www.w3.org/International/questions/qa-choosing-language-tags"},"children":["W3.org guide"]}," and the ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry"},"children":["language subtag registry"]}," for more information about language tags and subtags."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["sitemap"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["siteUrl"]}," is configured in ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs-legacy/developer-portal/configuration/siteconfig/meta"},"children":["the meta section"]}," of the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["siteConfig.yaml"]}," file, a sitemap is automatically generated for the portal. The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sitemap"]}," object can then be added to the front matter of individual pages to control their sitemap tags. The following tags are supported: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["changefreq"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["priority"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastmod"]},". Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["changefreq"]}," to indicate how often the page is updated (never, yearly, monthly, weekly, daily, hourly, always). Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["priority"]}," to indicate page importance (a number in range from 0 to 1), which may result in the page being indexed more often or ranking higher in search results. Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastmod"]}," to indicate when the page was last updated (a timestamp in the ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://www.w3.org/TR/NOTE-datetime"},"children":["W3C format"]},")."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["title"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sets the page title; equivalent of the HTML ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[""]}," tag. It's displayed in the browser's title bar and/or tab. If ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["label"]}," is not defined for the page in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sidebars.yaml"]},", the value of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["title"]}," is automatically used as the page name in the sidebar."]}]}]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"md","header":{"controls":{"copy":{}}},"source":"---\nseo:\n title: Example Markdown page\n description: GitHub-flavored Markdown example\n image: .images/example-page.png\n keywords: 'markdown, github'\n lang: en-US\n jsonLd:\n '@context': 'https://schema.org'\n '@type': 'Organization'\n url: 'http://www.example.com'\n name: My website\n contactPoint:\n '@type': 'ContactPoint'\n telephone: '+1111111111111'\n contactType: 'Customer service'\n sitemap:\n changefreq: 'daily'\n priority: 0.3\n lastmod: 1997-07-16T19:20:30.45+01:00\n---\n","lang":"md"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"shownextbutton","__idx":11},"children":["showNextButton"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},", hides the \"Back to\" navigation button at the bottom of each MD(X) page."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"md","header":{"controls":{"copy":{}}},"source":"---\nseo:\n title: Markdown example\nshowNextButton: false\n---\n","lang":"md"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"showprevbutton","__idx":12},"children":["showPrevButton"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},", hides the \"Next to\" navigation button at the bottom of each MD(X) page."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"md","header":{"controls":{"copy":{}}},"source":"---\nseo:\n title: Markdown example\nshowPrevButton: false\n---\n","lang":"md"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"toc","__idx":13},"children":["toc"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Configures the behavior of page table of contents. Use it to override global portal settings and hide/show a table of contents (ToC) on the right side of the page. When the TOC is enabled, you can set its maximum depth (amount of heading levels) as an integer value. Read more about ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs-legacy/developer-portal/guides/page-toc"},"children":["ToC configuration"]}]},{"$$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":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enable"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},", displays a table of contents (ToC) on the right side of the page."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["maxDepth"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["This option is dependent on and related to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enable: true"]},". Use it to set the maximum depth (amount of heading levels) displayed in the table of contents. The value must be provided as an integer. The default value is 4, which means that headings from H1 to H4 are displayed in the TOC."]}]}]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"md","header":{"controls":{"copy":{}}},"source":"---\nseo:\n title: Markdown example\ntoc:\n enable: true\n maxDepth: 2\n---\n","lang":"md"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"deprecated-front-matter-options","__idx":14},"children":["Deprecated front matter options"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Deprecated as a top-level option - use in ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"#seo"},"children":["seo"]}," instead"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["image"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["keywords"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["title"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lang"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sitemap"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Deprecated - use ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"#toc"},"children":["toc"]}," instead"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enableToc"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tocMaxDepth"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"unordered-lists","__idx":15},"children":["Unordered lists"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Examples"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"md","header":{"controls":{"copy":{}}},"source":"- API Reference\n- Portal\n- Workflows\n","lang":"md"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Using a different character for list items:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"md","header":{"controls":{"copy":{}}},"source":"- API Reference\n- Portal\n- Workflows\n","lang":"md"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Both examples render like this:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["API Reference"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Portal"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Workflows"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To create a nested list, indent items:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"md","header":{"controls":{"copy":{}}},"source":"- API Reference\n - Hosted\n - On-premise\n- Developer portal\n - Hosted\n - On-premise\n- Workflows\n","lang":"md"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The example above renders like this:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["API Reference",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Hosted"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["On-premise"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Developer portal",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Hosted"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["On-premise"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Workflows"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"numbered-lists","__idx":16},"children":["Numbered lists"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"md","header":{"controls":{"copy":{}}},"source":"1. Wake up\n2. Brush teeth\n3. Exercise\n","lang":"md"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The example above renders like this:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Wake up"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Brush teeth"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Exercise"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"numbered-list-with-code-snippets","__idx":17},"children":["Numbered list with code snippets"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"pre","attributes":{},"children":["\n1. Code snippets in a list.\n1. ```javascript\n javascript;\n ```\n\n ```python\n python\n ```\n\n ```cpp\n c++\n ```\n"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The example above renders like this:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Code snippets in a list."]}]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"javascript","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":" javascript;\n","lang":"javascript"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"python","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"python","header":{"controls":{"copy":{}}},"source":"python\n","lang":"python"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"cpp","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"cpp","header":{"controls":{"copy":{}}},"source":"c++\n","lang":"cpp"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"free-form-code-samples","__idx":18},"children":["Free-form code samples"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Code samples support syntax highlighting, as long as you specify the language at the beginning of your code block."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example: Python code highlighting"]}]},{"$$mdtype":"Tag","name":"pre","attributes":{},"children":["\n```python\nprices = {'apple': 0.40, 'banana': 0.50}\nmy_purchase = {\n 'apple': 1,\n 'banana': 6}\ngrocery_bill = sum(prices[fruit] * my_purchase[fruit]\n for fruit in my_purchase)\nprint ('I owe the grocer $%.2f' % grocery_bill)\n```\n"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The example above renders like this:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"python","header":{"controls":{"copy":{}}},"source":"prices = {'apple': 0.40, 'banana': 0.50}\nmy_purchase = {\n 'apple': 1,\n 'banana': 6}\ngrocery_bill = sum(prices[fruit] * my_purchase[fruit]\n for fruit in my_purchase)\nprint ('I owe the grocer $%.2f' % grocery_bill)\n","lang":"python"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All Markdown code blocks support the copy button, regardless of the language of the code sample. When enabled, the copy button is displayed in the upper right corner of the code block. You can change the default copy button text, the tooltip text, and customize the success message in the ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs-legacy/developer-portal/configuration/siteconfig/copy-codesnippet"},"children":["copyCodeSnippet section"]}," of the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["siteConfig.yaml"]}," file."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"tabbed-code-samples","__idx":19},"children":["Tabbed code samples"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To make your code samples display in tabs, write them sequentially (one immediately after the other, without any text between) and specify the language at the beginning of each code block."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The language name is used as the default tab title. You can set a custom tab title by adding it after the language, or by replacing the language altogether with a custom string. Note that syntax highlighting does not work for tabs without a specified language."]},{"$$mdtype":"Tag","name":"pre","attributes":{},"children":["\n```javascript\njavascript;\n```\n\n```python\npython\n```\n\n```java title\nexample text\n```\n\n```custom tab name\nexample text\n```\n"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The example above renders like this:"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"javascript","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"javascript;\n","lang":"javascript"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"python","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"python","header":{"controls":{"copy":{}}},"source":"python\n","lang":"python"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"java title","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"java","header":{"controls":{"copy":{}}},"source":"example text\n","lang":"java"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"custom tab name","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"sh","header":{"controls":{"copy":{}}},"source":"example text\n","lang":"sh"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"built-with","__idx":20},"children":["Built with"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://github.com/markdown-it/markdown-it"},"children":["markdown-it"]}," for Markdown parsing"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"http://codemirror.net/"},"children":["CodeMirror"]}," for the awesome syntax-highlighted editor"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"http://softwaremaniacs.org/soft/highlight/en/"},"children":["highlight.js"]}," for syntax highlighting in output code blocks"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://github.com/dankogai/js-deflate"},"children":["js-deflate"]}," for gzipping of data to make it fit in URLs"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"customizable-images","__idx":21},"children":["Customizable images"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Important"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Markdown image resizing and styling is supported from version 1.0.0-beta.151."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When inserting images into your Markdown pages, you can specify their size and optionally style them with CSS properties."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Supported image size parameters are ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["width"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["height"]},", and you can set both or just one for each image. For image styling, you can use any of the CSS properties supported by the ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://www.gatsbyjs.com/plugins/gatsby-remark-image-attributes/"},"children":["gatsby-remark-image-attributes plugin"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To customize an image, add a space, then a string with a leading ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["#"]}," symbol after the image file name, followed by the size parameters and/or CSS properties you want to use. The following examples illustrate different ways to customize images in your Markdown files."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Example with custom width","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"md","header":{"controls":{"copy":{}}},"source":"Let's insert an image.\n\n\n","lang":"md"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Example with custom width and height","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"md","header":{"controls":{"copy":{}}},"source":"Let's insert an image.\n\n\n","lang":"md"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Example with custom CSS styling","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"md","header":{"controls":{"copy":{}}},"source":"Let's insert an image.\n\n\n","lang":"md"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"admonitions","__idx":22},"children":["Admonitions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Admonitions are text blocks with special formatting. Use them to highlight important information, warn users, or provide hints and tips. The icon to the left of the text is generated automatically according to the admonition type."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following admonition types are supported: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["info"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["success"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["warning"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["danger"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["attention"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Here is how to insert each type of admonition, followed by an example of what it looks like when rendered in the portal."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Info"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"md","header":{"controls":{"copy":{}}},"source":":::info Optional title\n\nJust FYI\n\n:::\n","lang":"md"},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Optional title"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Just FYI"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Success"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"md","header":{"controls":{"copy":{}}},"source":":::success Success message\n\nHooyah!\n\n:::\n","lang":"md"},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"success","name":"Success message"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Hooyah!"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Warning"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"md","header":{"controls":{"copy":{}}},"source":":::warning Warning\n\nI told you so!\n\n:::\n","lang":"md"},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Warning"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["I told you so!"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Danger"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"md","header":{"controls":{"copy":{}}},"source":":::danger Danger\n\nI really told you so!\n\n:::\n","lang":"md"},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"danger","name":"Danger"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["I really told you so!"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Attention"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"md","header":{"controls":{"copy":{}}},"source":":::attention Attention\n\nNow that I have your attention...\n\n:::\n","lang":"md"},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Attention"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Now that I have your attention..."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"legacy-admonitions-syntax","__idx":23},"children":["Legacy admonitions syntax"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["From version 1.0.0-beta.118 of the Developer portal, the HTML-based syntax for inserting admonitions is deprecated. We strongly recommend replacing it with the new syntax in your portal project."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example legacy syntax for warnings"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"html","header":{"controls":{"copy":{}}},"source":"<div class=\"warning\">Warning: I told you so!</div>\n","lang":"html"},"children":[]}]},"frontmatter":{"seo":{"title":"Supported Markdown features","description":"Using Markdown in your developer portal"},"toc":{"enable":true,"maxDepth":3},"excludeFromSearch":true},"tagList":["admonition","html","partial","tab","tabs"],"title":"Supported Markdown features","lastModified":"2025-05-28T16:01:32.000Z"}