| </div></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/logo-black.svg" alt="Apache Pulsar logo" class="themedImage_ToTc themedImage--light_HNdA" height="25" width="127"><img src="/img/logo-black.svg" alt="Apache Pulsar logo" class="themedImage_ToTc themedImage--dark_i4oU" height="25" width="127"></div><b class="navbar__title text--truncate"></b></a><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Get Started</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/docs/3.2.x/concepts-overview/">Concepts</a></li><li><a class="dropdown__link" href="/docs/3.2.x/">Quickstart</a></li><li><a class="dropdown__link" href="/ecosystem/">Ecosystem</a></li></ul></div><a class="navbar__item navbar__link" href="/docs/3.2.x/">Docs</a><a class="navbar__item navbar__link" href="/features/">Features</a><a class="navbar__item navbar__link" href="/use-cases/">Use Cases</a><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link community-dropdown">Community</a><ul class="dropdown__menu"><li><a class="dropdown__link scroll-link scroll-welcome" id="scroll-welcome" href="/community/">Welcome</a></li><li><a class="dropdown__link scroll-link scroll-discussions" id="scroll-discussions" href="/community/#section-discussions">Discussions</a></li><li><a class="dropdown__link scroll-link" id="scroll-governance" href="/community/#section-governance">Governance</a></li><li><a class="dropdown__link scroll-link" id="scroll-community" href="/community/#section-community">Meet the Community</a></li><li><a class="dropdown__link scroll-link" id="scroll-contribute" href="/community/#section-contribute">Contribute</a></li><li><a aria-current="page" class="dropdown__link dropdown__link--active" href="/contribute/">Contribution Guide</a></li><li><a href="https://github.com/apache/pulsar/wiki" target="_blank" rel="noopener noreferrer" class="dropdown__link">Wiki</a></li><li><a href="https://github.com/apache/pulsar/issues" target="_blank" rel="noopener noreferrer" class="dropdown__link">Issue Tracking</a></li></ul></div><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Learn</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/blog/">Blog</a></li><li><a class="dropdown__link" href="/books/">Books</a></li><li><a class="dropdown__link" href="/case-studies/">Case Studies</a></li><li><a class="dropdown__link" href="/articles/">Articles</a></li><li><a class="dropdown__link" href="/presentations/">Presentations</a></li><li><a class="dropdown__link" href="/events/">Events</a></li></ul></div></div><div class="navbar__items navbar__items--right"><a class="navbar__item navbar__link navbar_download_button" href="/download/">Download</a><div class="searchBox_ZlJk"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20" aria-hidden="true"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebarViewport_Xe31"><div class="sidebar_mhZE"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG menuWithAnnouncementBar_GW3s"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/contribute/">About</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/contribute/setup-building/">Getting started</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/contribute/develop-coding-conventions/">Development</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/contribute/testing-licenses/">Testing and CI</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" href="/contribute/site-intro/">Website</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/contribute/site-intro/">Introduction</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/contribute/document-preview/">Previewing content</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/contribute/document-syntax/">Writing syntax</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/contribute/document-intro/">Documentation</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/contribute/release-policy/">Releases</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/contribute/become-core-developer/">Committers</a></div></li></ul></nav></div></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">Website</span><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Writing syntax</span><meta itemprop="position" content="2"></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Writing syntax</h1></header><p>This guide explains how to write Pulsar documentation using the MDX-compatible Markdown syntax.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="background">Background<a href="#background" class="hash-link" aria-label="Direct link to Background" title="Direct link to Background"></a></h2><p>The Pulsar documentation uses <a href="https://www.markdownguide.org/basic-syntax/" target="_blank" rel="noopener noreferrer">Markdown</a> as its markup language and <a href="https://docusaurus.io/" target="_blank" rel="noopener noreferrer">Docusaurus</a> for generating the documentation and website, with <a href="https://mdxjs.com/" target="_blank" rel="noopener noreferrer">MDX</a> enhancement.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="why-use-new-markdown-syntax">Why use new Markdown syntax?<a href="#why-use-new-markdown-syntax" class="hash-link" aria-label="Direct link to Why use new Markdown syntax?" title="Direct link to Why use new Markdown syntax?"></a></h3><p>The new Pulsar website is upgraded to Docusaurus V2, which uses MDX as the parsing engine. MDX can do much more than just parsing standard Markdown syntax, like rendering React components inside your documents as well.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="how-to-test-doc-changes">How to test doc changes?<a href="#how-to-test-doc-changes" class="hash-link" aria-label="Direct link to How to test doc changes?" title="Direct link to How to test doc changes?"></a></h3><p>You can play with the MDX format in the <a href="https://mdxjs.com/playground/" target="_blank" rel="noopener noreferrer">MDX Playground</a>. Write some MDX to find out what it turns into. You can see the rendered result, the generated code, and the intermediary ASTs. This can be helpful for debugging or exploring.</p><p>For how to test doc changes locally, read the <a href="/contribute/document-preview/">Content Preview Guide</a>.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="syntax">Syntax<a href="#syntax" class="hash-link" aria-label="Direct link to Syntax" title="Direct link to Syntax"></a></h2><p>This guide just highlights a few selected important rules and frequently used syntax. For the complete syntax guide, read the <a href="https://docusaurus.io/docs/markdown-features" target="_blank" rel="noopener noreferrer">Markdown Features</a> document from Docusaurus and <a href="https://mdxjs.com/docs/what-is-mdx/#markdown" target="_blank" rel="noopener noreferrer">Markdown</a> document from MDX.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="markdown">Markdown<a href="#markdown" class="hash-link" aria-label="Direct link to Markdown" title="Direct link to Markdown"></a></h3><ul><li>Use Markdown rather than HTML as much as possible, or else MDX may not recognize it. For example, when constructing complex tables, do not use <code><table></code>.</li><li>Use closing tags. <code><li><li/></code> and <code><br/></code> are especially useful for constructing complex tables, such as creating a list and adding a blank line.</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="example-1">Example 1<a href="#example-1" class="hash-link" aria-label="Direct link to Example 1" title="Direct link to Example 1"></a></h4><div class="language-markdown codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-markdown codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token table table-header-row punctuation" style="color:rgb(248, 248, 242)">|</span><span class="token table table-header-row table-header important"> Directory </span><span class="token table table-header-row punctuation" style="color:rgb(248, 248, 242)">|</span><span class="token table table-header-row table-header important"> Contains </span><span class="token table table-header-row punctuation" style="color:rgb(248, 248, 242)">|</span><span class="token table table-header-row"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token table table-header-row"></span><span class="token table table-line punctuation" style="color:rgb(248, 248, 242)">|</span><span class="token table table-line punctuation" style="color:rgb(248, 248, 242)">:----------</span><span class="token table table-line punctuation" style="color:rgb(248, 248, 242)">|</span><span class="token table table-line punctuation" style="color:rgb(248, 248, 242)">:------------------------------------</span><span class="token table table-line punctuation" style="color:rgb(248, 248, 242)">|</span><span class="token table table-line"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token table table-line"></span><span class="token table table-data-rows punctuation" style="color:rgb(248, 248, 242)">|</span><span class="token table table-data-rows table-data"> </span><span class="token table table-data-rows table-data bold punctuation" style="color:rgb(248, 248, 242)">**</span><span class="token table table-data-rows table-data bold content">Hello</span><span class="token table table-data-rows table-data bold punctuation" style="color:rgb(248, 248, 242)">**</span><span class="token table table-data-rows table-data"> </span><span class="token table table-data-rows punctuation" style="color:rgb(248, 248, 242)">|</span><span class="token table table-data-rows table-data"> </span><span class="token table table-data-rows table-data tag punctuation" style="color:rgb(248, 248, 242)"><</span><span class="token table table-data-rows table-data tag" style="color:rgb(255, 121, 198)">li</span><span class="token table table-data-rows table-data tag punctuation" style="color:rgb(248, 248, 242)">></span><span class="token table table-data-rows table-data">a</span><span class="token table table-data-rows table-data tag punctuation" style="color:rgb(248, 248, 242)"></</span><span class="token table table-data-rows table-data tag" style="color:rgb(255, 121, 198)">li</span><span class="token table table-data-rows table-data tag punctuation" style="color:rgb(248, 248, 242)">></span><span class="token table table-data-rows table-data tag punctuation" style="color:rgb(248, 248, 242)"><</span><span class="token table table-data-rows table-data tag" style="color:rgb(255, 121, 198)">li</span><span class="token table table-data-rows table-data tag punctuation" style="color:rgb(248, 248, 242)">></span><span class="token table table-data-rows table-data">b</span><span class="token table table-data-rows table-data tag punctuation" style="color:rgb(248, 248, 242)"></</span><span class="token table table-data-rows table-data tag" style="color:rgb(255, 121, 198)">li</span><span class="token table table-data-rows table-data tag punctuation" style="color:rgb(248, 248, 242)">></span><span class="token table table-data-rows table-data tag punctuation" style="color:rgb(248, 248, 242)"><</span><span class="token table table-data-rows table-data tag" style="color:rgb(255, 121, 198)">br</span><span class="token table table-data-rows table-data tag punctuation" style="color:rgb(248, 248, 242)">/></span><span class="token table table-data-rows table-data tag punctuation" style="color:rgb(248, 248, 242)"><</span><span class="token table table-data-rows table-data tag" style="color:rgb(255, 121, 198)">li</span><span class="token table table-data-rows table-data tag punctuation" style="color:rgb(248, 248, 242)">></span><span class="token table table-data-rows table-data">c</span><span class="token table table-data-rows table-data tag punctuation" style="color:rgb(248, 248, 242)"></</span><span class="token table table-data-rows table-data tag" style="color:rgb(255, 121, 198)">li</span><span class="token table table-data-rows table-data tag punctuation" style="color:rgb(248, 248, 242)">></span><span class="token table table-data-rows table-data"> </span><span class="token table table-data-rows punctuation" style="color:rgb(248, 248, 242)">|</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><table><thead><tr><th align="left">Directory</th><th align="left">Contains</th></tr></thead><tbody><tr><td align="left"><strong>Hello</strong></td><td align="left"><li>a</li><li>b</li><br><li>c</li></td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="example-2">Example 2<a href="#example-2" class="hash-link" aria-label="Direct link to Example 2" title="Direct link to Example 2"></a></h4><div class="language-markdown codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-markdown codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token table table-header-row punctuation" style="color:rgb(248, 248, 242)">|</span><span class="token table table-header-row table-header important"> a </span><span class="token table table-header-row punctuation" style="color:rgb(248, 248, 242)">|</span><span class="token table table-header-row table-header important"> b </span><span class="token table table-header-row punctuation" style="color:rgb(248, 248, 242)">|</span><span class="token table table-header-row table-header important"> c </span><span class="token table table-header-row punctuation" style="color:rgb(248, 248, 242)">|</span><span class="token table table-header-row"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token table table-header-row"></span><span class="token table table-line punctuation" style="color:rgb(248, 248, 242)">|</span><span class="token table table-line punctuation" style="color:rgb(248, 248, 242)">-----</span><span class="token table table-line punctuation" style="color:rgb(248, 248, 242)">|</span><span class="token table table-line punctuation" style="color:rgb(248, 248, 242)">-----</span><span class="token table table-line punctuation" style="color:rgb(248, 248, 242)">|</span><span class="token table table-line punctuation" style="color:rgb(248, 248, 242)">--------------------------</span><span class="token table table-line punctuation" style="color:rgb(248, 248, 242)">|</span><span class="token table table-line"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token table table-line"></span><span class="token table table-data-rows punctuation" style="color:rgb(248, 248, 242)">|</span><span class="token table table-data-rows table-data"> aa </span><span class="token table table-data-rows punctuation" style="color:rgb(248, 248, 242)">|</span><span class="token table table-data-rows table-data"> bb </span><span class="token table table-data-rows punctuation" style="color:rgb(248, 248, 242)">|</span><span class="token table table-data-rows table-data"> cc1</span><span class="token table table-data-rows table-data tag punctuation" style="color:rgb(248, 248, 242)"><</span><span class="token table table-data-rows table-data tag" style="color:rgb(255, 121, 198)">br</span><span class="token table table-data-rows table-data tag punctuation" style="color:rgb(248, 248, 242)">/></span><span class="token table table-data-rows table-data">cc2</span><span class="token table table-data-rows table-data tag punctuation" style="color:rgb(248, 248, 242)"><</span><span class="token table table-data-rows table-data tag" style="color:rgb(255, 121, 198)">br</span><span class="token table table-data-rows table-data tag punctuation" style="color:rgb(248, 248, 242)">/></span><span class="token table table-data-rows table-data tag punctuation" style="color:rgb(248, 248, 242)"><</span><span class="token table table-data-rows table-data tag" style="color:rgb(255, 121, 198)">br</span><span class="token table table-data-rows table-data tag punctuation" style="color:rgb(248, 248, 242)">/></span><span class="token table table-data-rows table-data">cc3 </span><span class="token table table-data-rows punctuation" style="color:rgb(248, 248, 242)">|</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><table><thead><tr><th>a</th><th>b</th><th>c</th></tr></thead><tbody><tr><td>aa</td><td>bb</td><td>cc1<br>cc2<br><br>cc3</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="tab">Tab<a href="#tab" class="hash-link" aria-label="Direct link to Tab" title="Direct link to Tab"></a></h3><p>Before using multiple tabs, add these imports at the beginning of the file:</p><div class="language-markdown codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-markdown codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">````mdx-code-block</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">import Tabs from '@theme/Tabs';</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">import TabItem from '@theme/TabItem'; </span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">````</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Then, you can write tabs as:</p><div class="language-markdown codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-markdown codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token tag punctuation" style="color:rgb(248, 248, 242)"><</span><span class="token tag" style="color:rgb(255, 121, 198)">Tabs</span><span class="token tag punctuation" style="color:rgb(248, 248, 242)">></span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token tag punctuation" style="color:rgb(248, 248, 242)"><</span><span class="token tag" style="color:rgb(255, 121, 198)">TabItem</span><span class="token tag" style="color:rgb(255, 121, 198)"> </span><span class="token tag attr-name" style="color:rgb(241, 250, 140)">value</span><span class="token tag attr-value punctuation attr-equals" style="color:rgb(248, 248, 242)">=</span><span class="token tag attr-value punctuation" style="color:rgb(248, 248, 242)">"</span><span class="token tag attr-value" style="color:rgb(255, 121, 198)">apple</span><span class="token tag attr-value punctuation" style="color:rgb(248, 248, 242)">"</span><span class="token tag" style="color:rgb(255, 121, 198)"> </span><span class="token tag attr-name" style="color:rgb(241, 250, 140)">label</span><span class="token tag attr-value punctuation attr-equals" style="color:rgb(248, 248, 242)">=</span><span class="token tag attr-value punctuation" style="color:rgb(248, 248, 242)">"</span><span class="token tag attr-value" style="color:rgb(255, 121, 198)">Apple</span><span class="token tag attr-value punctuation" style="color:rgb(248, 248, 242)">"</span><span class="token tag" style="color:rgb(255, 121, 198)"> </span><span class="token tag attr-name" style="color:rgb(241, 250, 140)">default</span><span class="token tag punctuation" style="color:rgb(248, 248, 242)">></span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> This is an apple 🍎</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token tag punctuation" style="color:rgb(248, 248, 242)"></</span><span class="token tag" style="color:rgb(255, 121, 198)">TabItem</span><span class="token tag punctuation" style="color:rgb(248, 248, 242)">></span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token tag punctuation" style="color:rgb(248, 248, 242)"><</span><span class="token tag" style="color:rgb(255, 121, 198)">TabItem</span><span class="token tag" style="color:rgb(255, 121, 198)"> </span><span class="token tag attr-name" style="color:rgb(241, 250, 140)">value</span><span class="token tag attr-value punctuation attr-equals" style="color:rgb(248, 248, 242)">=</span><span class="token tag attr-value punctuation" style="color:rgb(248, 248, 242)">"</span><span class="token tag attr-value" style="color:rgb(255, 121, 198)">orange</span><span class="token tag attr-value punctuation" style="color:rgb(248, 248, 242)">"</span><span class="token tag" style="color:rgb(255, 121, 198)"> </span><span class="token tag attr-name" style="color:rgb(241, 250, 140)">label</span><span class="token tag attr-value punctuation attr-equals" style="color:rgb(248, 248, 242)">=</span><span class="token tag attr-value punctuation" style="color:rgb(248, 248, 242)">"</span><span class="token tag attr-value" style="color:rgb(255, 121, 198)">Orange</span><span class="token tag attr-value punctuation" style="color:rgb(248, 248, 242)">"</span><span class="token tag punctuation" style="color:rgb(248, 248, 242)">></span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> This is an orange 🍊</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token tag punctuation" style="color:rgb(248, 248, 242)"></</span><span class="token tag" style="color:rgb(255, 121, 198)">TabItem</span><span class="token tag punctuation" style="color:rgb(248, 248, 242)">></span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token tag punctuation" style="color:rgb(248, 248, 242)"><</span><span class="token tag" style="color:rgb(255, 121, 198)">TabItem</span><span class="token tag" style="color:rgb(255, 121, 198)"> </span><span class="token tag attr-name" style="color:rgb(241, 250, 140)">value</span><span class="token tag attr-value punctuation attr-equals" style="color:rgb(248, 248, 242)">=</span><span class="token tag attr-value punctuation" style="color:rgb(248, 248, 242)">"</span><span class="token tag attr-value" style="color:rgb(255, 121, 198)">banana</span><span class="token tag attr-value punctuation" style="color:rgb(248, 248, 242)">"</span><span class="token tag" style="color:rgb(255, 121, 198)"> </span><span class="token tag attr-name" style="color:rgb(241, 250, 140)">label</span><span class="token tag attr-value punctuation attr-equals" style="color:rgb(248, 248, 242)">=</span><span class="token tag attr-value punctuation" style="color:rgb(248, 248, 242)">"</span><span class="token tag attr-value" style="color:rgb(255, 121, 198)">Banana</span><span class="token tag attr-value punctuation" style="color:rgb(248, 248, 242)">"</span><span class="token tag punctuation" style="color:rgb(248, 248, 242)">></span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> This is a banana 🍌</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token tag punctuation" style="color:rgb(248, 248, 242)"></</span><span class="token tag" style="color:rgb(255, 121, 198)">TabItem</span><span class="token tag punctuation" style="color:rgb(248, 248, 242)">></span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"></span><span class="token tag punctuation" style="color:rgb(248, 248, 242)"></</span><span class="token tag" style="color:rgb(255, 121, 198)">Tabs</span><span class="token tag punctuation" style="color:rgb(248, 248, 242)">></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><div class="tabs-container tabList__CuJ"><ul role="tablist" aria-orientation="horizontal" class="tabs"><li role="tab" tabindex="0" aria-selected="true" class="tabs__item tabItem_LNqP tabs__item--active">Apple</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">Orange</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">Banana</li></ul><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6">This is an apple 🍎</div><div role="tabpanel" class="tabItem_Ymn6" hidden="">This is an orange 🍊</div><div role="tabpanel" class="tabItem_Ymn6" hidden="">This is a banana 🍌</div></div></div><p>Read more about how to write multiple tabs at <a href="https://docusaurus.io/docs/markdown-features/tabs" target="_blank" rel="noopener noreferrer">Tabs</a>.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="code-blocks">Code blocks<a href="#code-blocks" class="hash-link" aria-label="Direct link to Code blocks" title="Direct link to Code blocks"></a></h3><p>Read more about how to use syntax highlighting and supported languages at <a href="https://docusaurus.io/docs/markdown-features/code-blocks#syntax-highlighting" target="_blank" rel="noopener noreferrer">Syntax highlighting</a>.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="admonitions">Admonitions<a href="#admonitions" class="hash-link" aria-label="Direct link to Admonitions" title="Direct link to Admonitions"></a></h3><p>Docusaurus supports these admonitions:</p><div class="language-markdown codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-markdown codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">:::note</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">Some </span><span class="token bold punctuation" style="color:rgb(248, 248, 242)">**</span><span class="token bold content">content</span><span class="token bold punctuation" style="color:rgb(248, 248, 242)">**</span><span class="token plain"> with </span><span class="token italic punctuation" style="color:rgb(248, 248, 242)">_</span><span class="token italic content">Markdown</span><span class="token italic punctuation" style="color:rgb(248, 248, 242)">_</span><span class="token plain"> </span><span class="token code-snippet code keyword" style="color:rgb(189, 147, 249);font-style:italic">`syntax`</span><span class="token plain">.</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">:::</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">:::tip</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">Some </span><span class="token bold punctuation" style="color:rgb(248, 248, 242)">**</span><span class="token bold content">content</span><span class="token bold punctuation" style="color:rgb(248, 248, 242)">**</span><span class="token plain"> with </span><span class="token italic punctuation" style="color:rgb(248, 248, 242)">_</span><span class="token italic content">Markdown</span><span class="token italic punctuation" style="color:rgb(248, 248, 242)">_</span><span class="token plain"> </span><span class="token code-snippet code keyword" style="color:rgb(189, 147, 249);font-style:italic">`syntax`</span><span class="token plain">.</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">:::</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">:::info</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">Some </span><span class="token bold punctuation" style="color:rgb(248, 248, 242)">**</span><span class="token bold content">content</span><span class="token bold punctuation" style="color:rgb(248, 248, 242)">**</span><span class="token plain"> with </span><span class="token italic punctuation" style="color:rgb(248, 248, 242)">_</span><span class="token italic content">Markdown</span><span class="token italic punctuation" style="color:rgb(248, 248, 242)">_</span><span class="token plain"> </span><span class="token code-snippet code keyword" style="color:rgb(189, 147, 249);font-style:italic">`syntax`</span><span class="token plain">.</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">:::</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">:::caution</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">Some </span><span class="token bold punctuation" style="color:rgb(248, 248, 242)">**</span><span class="token bold content">content</span><span class="token bold punctuation" style="color:rgb(248, 248, 242)">**</span><span class="token plain"> with </span><span class="token italic punctuation" style="color:rgb(248, 248, 242)">_</span><span class="token italic content">Markdown</span><span class="token italic punctuation" style="color:rgb(248, 248, 242)">_</span><span class="token plain"> </span><span class="token code-snippet code keyword" style="color:rgb(189, 147, 249);font-style:italic">`syntax`</span><span class="token plain">.</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">:::</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">:::danger</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">Some </span><span class="token bold punctuation" style="color:rgb(248, 248, 242)">**</span><span class="token bold content">content</span><span class="token bold punctuation" style="color:rgb(248, 248, 242)">**</span><span class="token plain"> with </span><span class="token italic punctuation" style="color:rgb(248, 248, 242)">_</span><span class="token italic content">Markdown</span><span class="token italic punctuation" style="color:rgb(248, 248, 242)">_</span><span class="token plain"> </span><span class="token code-snippet code keyword" style="color:rgb(189, 147, 249);font-style:italic">`syntax`</span><span class="token plain">.</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">:::</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><div class="theme-admonition theme-admonition-note alert alert--secondary admonition_LlT9"><div class="admonitionHeading_tbUL"><span class="admonitionIcon_kALy"><svg viewBox="0 0 14 16"><path fill-rule="evenodd" d="M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"></path></svg></span>note</div><div class="admonitionContent_S0QG"><p>Some <strong>content</strong> with <em>Markdown</em> <code>syntax</code>.</p></div></div><div class="theme-admonition theme-admonition-tip alert alert--success admonition_LlT9"><div class="admonitionHeading_tbUL"><span class="admonitionIcon_kALy"><svg viewBox="0 0 12 16"><path fill-rule="evenodd" d="M6.5 0C3.48 0 1 2.19 1 5c0 .92.55 2.25 1 3 1.34 2.25 1.78 2.78 2 4v1h5v-1c.22-1.22.66-1.75 2-4 .45-.75 1-2.08 1-3 0-2.81-2.48-5-5.5-5zm3.64 7.48c-.25.44-.47.8-.67 1.11-.86 1.41-1.25 2.06-1.45 3.23-.02.05-.02.11-.02.17H5c0-.06 0-.13-.02-.17-.2-1.17-.59-1.83-1.45-3.23-.2-.31-.42-.67-.67-1.11C2.44 6.78 2 5.65 2 5c0-2.2 2.02-4 4.5-4 1.22 0 2.36.42 3.22 1.19C10.55 2.94 11 3.94 11 5c0 .66-.44 1.78-.86 2.48zM4 14h5c-.23 1.14-1.3 2-2.5 2s-2.27-.86-2.5-2z"></path></svg></span>tip</div><div class="admonitionContent_S0QG"><p>Some <strong>content</strong> with <em>Markdown</em> <code>syntax</code>.</p></div></div><div class="theme-admonition theme-admonition-info alert alert--info admonition_LlT9"><div class="admonitionHeading_tbUL"><span class="admonitionIcon_kALy"><svg viewBox="0 0 14 16"><path fill-rule="evenodd" d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"></path></svg></span>info</div><div class="admonitionContent_S0QG"><p>Some <strong>content</strong> with <em>Markdown</em> <code>syntax</code>.</p></div></div><div class="theme-admonition theme-admonition-caution alert alert--warning admonition_LlT9"><div class="admonitionHeading_tbUL"><span class="admonitionIcon_kALy"><svg viewBox="0 0 16 16"><path fill-rule="evenodd" d="M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"></path></svg></span>caution</div><div class="admonitionContent_S0QG"><p>Some <strong>content</strong> with <em>Markdown</em> <code>syntax</code>.</p></div></div><div class="theme-admonition theme-admonition-danger alert alert--danger admonition_LlT9"><div class="admonitionHeading_tbUL"><span class="admonitionIcon_kALy"><svg viewBox="0 0 12 16"><path fill-rule="evenodd" d="M5.05.31c.81 2.17.41 3.38-.52 4.31C3.55 5.67 1.98 6.45.9 7.98c-1.45 2.05-1.7 6.53 3.53 7.7-2.2-1.16-2.67-4.52-.3-6.61-.61 2.03.53 3.33 1.94 2.86 1.39-.47 2.3.53 2.27 1.67-.02.78-.31 1.44-1.13 1.81 3.42-.59 4.78-3.42 4.78-5.56 0-2.84-2.53-3.22-1.25-5.61-1.52.13-2.03 1.13-1.89 2.75.09 1.08-1.02 1.8-1.86 1.33-.67-.41-.66-1.19-.06-1.78C8.18 5.31 8.68 2.45 5.05.32L5.03.3l.02.01z"></path></svg></span>danger</div><div class="admonitionContent_S0QG"><p>Some <strong>content</strong> with <em>Markdown</em> <code>syntax</code>.</p></div></div><p>Read more about how to write admonitions at <a href="https://docusaurus.io/docs/markdown-features/admonitions" target="_blank" rel="noopener noreferrer">Admonitions</a>.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="assets">Assets<a href="#assets" class="hash-link" aria-label="Direct link to Assets" title="Direct link to Assets"></a></h3><p>Static assets are hosted under <code>/assets</code> for all documentations:</p><div class="language-markdown codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-markdown codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token url operator">!</span><span class="token url">[</span><span class="token url content">Page Linking</span><span class="token url">](</span><span class="token url">/assets/page-linking.png</span><span class="token url">)</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="indentation-and-space">Indentation and space<a href="#indentation-and-space" class="hash-link" aria-label="Direct link to Indentation and space" title="Direct link to Indentation and space"></a></h3><ul><li>Use the same indentation for running texts and code blocks.</li><li>For the content block after an <strong>ordered list</strong>, indent the content block by only 3 spaces (not 4 spaces).</li><li>For the content block after an <strong>unordered list</strong>, indent the content block by only 2 spaces.</li><li>Insert <strong>exact one</strong> empty line (not two empty lines or more) between code blocks and running texts.</li></ul><div class="theme-admonition theme-admonition-caution alert alert--warning admonition_LlT9"><div class="admonitionHeading_tbUL"><span class="admonitionIcon_kALy"><svg viewBox="0 0 16 16"><path fill-rule="evenodd" d="M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"></path></svg></span>caution</div><div class="admonitionContent_S0QG"><p>If you don't insert the empty line, the text cannot be rendered properly. You should encounter an error by <a href="/contribute/document-preview/">preview</a>. </p></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="metadata">Metadata<a href="#metadata" class="hash-link" aria-label="Direct link to Metadata" title="Direct link to Metadata"></a></h3><p>If you create a new <code>.md</code> file, add quotes for the value of <code>sidebar_label</code>.</p><div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-yaml codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token punctuation" style="color:rgb(248, 248, 242)">---</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"></span><span class="token key atrule">id</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> admin</span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain">api</span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain">partitioned</span><span class="token punctuation" style="color:rgb(248, 248, 242)">-</span><span class="token plain">topics</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"></span><span class="token key atrule">title</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> Managing partitioned topic</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"></span><span class="token key atrule">sidebar_label</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(255, 121, 198)">"Partitioned topics"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"></span><span class="token punctuation" style="color:rgb(248, 248, 242)">---</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>If you don't set the <code>sidebar_label</code> property, the label is default to <code>title</code>.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="tables">Tables<a href="#tables" class="hash-link" aria-label="Direct link to Tables" title="Direct link to Tables"></a></h3><p>To help tables be easier to maintain, consider adding additional spaces to the column widths to make them consistent. For examples:</p><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">| App name | Description | Requirements |</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">| :------- | :------------------ | :------------- |</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">| App 1 | Description text 1. | Requirements 1 |</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">| App 2 | Description text 2. | None |</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>To format tables easily, you can install a plugin or extension in your editor as below:</p><ul><li>Visual Studio Code: <a href="https://marketplace.visualstudio.com/items?itemName=darkriszty.markdown-table-prettify" target="_blank" rel="noopener noreferrer">Markdown Table Prettifier</a></li><li>Sublime Text: <a href="https://packagecontrol.io/packages/Markdown%20Table%20Formatter" target="_blank" rel="noopener noreferrer">Markdown Table Formatter</a></li><li>Atom: <a href="https://atom.io/packages/markdown-table-formatter" target="_blank" rel="noopener noreferrer">Markdown Table Formatter</a></li></ul><h3 class="anchor anchorWithStickyNavbar_LWe7" id="links">Links<a href="#links" class="hash-link" aria-label="Direct link to Links" title="Direct link to Links"></a></h3><p>Use links instead of summarizing to help preserve a single source of truth in Pulsar documentation.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="anchor-links">Anchor links<a href="#anchor-links" class="hash-link" aria-label="Direct link to Anchor links" title="Direct link to Anchor links"></a></h4><p>Headings generate anchor links when rendered. For example:</p><p><code>## This is an example</code> generates the anchor <code>#this-is-an-example</code>.</p><div class="theme-admonition theme-admonition-caution alert alert--warning admonition_LlT9"><div class="admonitionHeading_tbUL"><span class="admonitionIcon_kALy"><svg viewBox="0 0 16 16"><path fill-rule="evenodd" d="M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"></path></svg></span>caution</div><div class="admonitionContent_S0QG"><ul><li>Avoid cross-reference docs to headings unless you need to link to a specific section of the document. This avoids breaking anchors in the future in case the heading is changed.</li><li>If possible, avoid changing headings, because they're not only linked internally. There are various links to Pulsar documentation on the Internet, such as tutorials, presentations, StackOverflow posts, and other sources.</li></ul></div></div><h4 class="anchor anchorWithStickyNavbar_LWe7" id="links-to-internal-documentation">Links to internal documentation<a href="#links-to-internal-documentation" class="hash-link" aria-label="Direct link to Links to internal documentation" title="Direct link to Links to internal documentation"></a></h4><p>Internal refers to documentation in the same Pulsar project.</p><p>General rules:</p><ul><li>Use relative links rather than absolute URLs.</li><li>Do not prepend <code>./</code> or <code>../../</code> to links to files or directories.</li></ul><p>Examples:</p><table><thead><tr><th>Scenario</th><th>Good</th><th>Bad</th></tr></thead><tbody><tr><td>Cross-reference to other markdown file (/path/xx/ is not needed)</td><td><code>[Function overview](function-overview.md)</code></td><td><li><code>[Function overview](functions-overview)</code></li><li><code>[Function overview](https://pulsar.apache.org/docs/next/functions-overview/)</code></li><li><code>[Function overview](../../function-overview.md)</code></li></td></tr><tr><td>Cross-reference to other chapters in the same markdown file (# and - are needed)</td><td><code>[Install builtin connectors (optional)](#install-builtin-connectors-optional)</code></td><td>N/A</td></tr></tbody></table><p>Read more about how to write Markdown links at <a href="https://docusaurus.io/docs/markdown-features/links" target="_blank" rel="noopener noreferrer">Markdown links</a>.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="links-to-external-documentation">Links to external documentation<a href="#links-to-external-documentation" class="hash-link" aria-label="Direct link to Links to external documentation" title="Direct link to Links to external documentation"></a></h4><p>When describing interactions with external software, it's often helpful to include links to external documentation. When possible, make sure that you're linking to an <a href="#authoritative-sources">authoritative source</a>.</p><p>For example, if you're describing a feature in Microsoft's Active Directory, include a link to the official Microsoft documentation.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="link-to-a-specific-line-of-code">Link to a specific line of code<a href="#link-to-a-specific-line-of-code" class="hash-link" aria-label="Direct link to Link to a specific line of code" title="Direct link to Link to a specific line of code"></a></h4><p>Use a <strong>permalink</strong> when linking to a specific line in a file to ensure users land on the line you're referring to though lines of code change over time.</p><p><img loading="lazy" alt="alt_text" src="/assets/images/obtain-github-permalink-d6b28ee0883705a2adf8cc3993d6b19d.png" width="348" height="290" class="img_ev3q"></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="authoritative-sources">Authoritative sources<a href="#authoritative-sources" class="hash-link" aria-label="Direct link to Authoritative sources" title="Direct link to Authoritative sources"></a></h3><p>When citing external information, use sources that are written by the people who created the item or product in question. These sources are the most likely to be accurate and remain up to date.</p><ul><li><p>✅ Authoritative sources include the following:</p><ul><li><p>Official documentation for a product.</p><p>For example, if you're setting up an interface with the Google OAuth 2 authorization server, include a link to Google's documentation.</p></li><li><p>Official documentation for a project.</p><p>For example, if you're citing NodeJS functionality, refer directly to <a href="https://nodejs.org/en/docs/" target="_blank" rel="noopener noreferrer">NodeJS documentation</a>.</p></li><li><p>Books from an authoritative publisher.</p></li></ul></li><li><p>❌ Authoritative sources do not include the following:</p><ul><li>Personal blog posts.</li><li>Documentation from a company that describes another company's product.</li><li>Non-trustworthy articles.</li><li>Discussions on forums such as Stack Overflow.</li></ul></li></ul><p>While many of these sources to avoid can help you learn skills and or features, they can become obsolete quickly. Nobody is obliged to maintain any of these sites. Therefore, you should avoid using them as reference literature.</p><p>Non-authoritative sources are acceptable only if there is no equivalent authoritative source. Even then, focus on non-authoritative sources that are extensively cited or peer-reviewed.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="escape">Escape<a href="#escape" class="hash-link" aria-label="Direct link to Escape" title="Direct link to Escape"></a></h3><p>Escape <code><</code> and <code>></code> with back-quote or HTML escape characters.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="headings">Headings<a href="#headings" class="hash-link" aria-label="Direct link to Headings" title="Direct link to Headings"></a></h3><ul><li>Each documentation page begins with a <strong>level 2</strong> heading (<code>##</code>). This becomes the <code><h1></code> element when the page is rendered to HTML.</li><li>Do not skip a level.</li><li>Leave one blank line before and after the heading.</li><li>Do not use links as part of heading text.</li><li>When you change the heading text, the anchor link changes. To avoid broken links:<ul><li>Do not use step numbers in headings.</li><li>When possible, do not use words that might change in the future.</li></ul></li></ul></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/apache/pulsar-site/edit/main/contribute/document-syntax.md" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_vwxv"><span class="theme-last-updated">Last updated<!-- --> on <b><time datetime="2024-05-06T23:51:02.000Z">May 6, 2024</time></b> by <b>Dragos Misca</b></span></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><a class="pagination-nav__link pagination-nav__link--prev" href="/contribute/document-preview/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Previewing content</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/contribute/document-intro/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Introduction</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_jeP5 thin-scrollbar theme-doc-toc-desktop"><div class="border"><div style="color:var(--ifm-toc-link-color)">Was this helpful?</div><div style="border-width:1px;padding:3px;display:flex"><div style="justify-content:center;display:flex;border-radius:99999px;width:2.5rem;height:2.5rem;cursor:pointer;background:;color:"><svg style="width:initial;height:initial" width="12" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="M10.086 1.594A1 1 0 0 1 11 1a4 4 0 0 1 4 4v3h4.655a3 3 0 0 1 2.994 3.45l-1.38 9A3.002 3.002 0 0 1 18.275 23H4a3 3 0 0 1-3-3v-7a3 3 0 0 1 3-3h2.35l3.736-8.406ZM8 11.212l3.608-8.117A2 2 0 0 1 13 5v4a1 1 0 0 0 1 1h5.671a1 1 0 0 1 1 1.15l-1.38 9a1 1 0 0 1-1 .85H8v-9.788ZM6 21v-9H4a1 1 0 0 0-1 1v7a1 1 0 0 0 1 1h2Z" fill="currentColor"></path></svg></div><div style="justify-content:center;display:flex;border-radius:99999px;width:2.5rem;height:2.5rem;cursor:pointer;background:;color:"><svg style="width:initial;height:initial" width="12" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="M20.563 3.316A1.31 1.31 0 0 0 19.687 3h-1.688v9h1.688a1.31 1.31 0 0 0 1.312-1.077V4.077a1.31 1.31 0 0 0-.436-.761ZM16 12.788l-3.608 8.117A1.999 1.999 0 0 1 11 19v-4a1 1 0 0 0-1-1H4.328a1.002 1.002 0 0 1-1-1.15l1.38-9a1 1 0 0 1 1-.85h10.291v9.788ZM19.661 1a3.31 3.31 0 0 1 3.329 2.866c.006.044.01.09.01.134v7c0 .045-.004.09-.01.134A3.31 3.31 0 0 1 19.661 14h-2.012l-3.736 8.406a1 1 0 0 1-.914.594 4 4 0 0 1-4-4v-3H4.344a3 3 0 0 1-2.994-3.45l1.38-9A3.002 3.002 0 0 1 5.724 1h13.937Z" fill="currentColor"></path></svg></div></div><div class="Actions_uugI"><a target="_blank" class="Action_iBHd" href="https://github.com/apache/pulsar/issues/new?assignees=&labels=doc-required&projects=&template=doc.yml&title=%5BDoc%5D+">💡 Suggest changes</a><a target="_blank" class="Action_iBHd" href="https://github.com/apache/pulsar/discussions/new?category=q-a">🛟 Get support</a></div></div><ul class="table-of-contents table-of-contents__left-border"><li><a href="#background" class="table-of-contents__link toc-highlight">Background</a><ul><li><a href="#why-use-new-markdown-syntax" class="table-of-contents__link toc-highlight">Why use new Markdown syntax?</a></li><li><a href="#how-to-test-doc-changes" class="table-of-contents__link toc-highlight">How to test doc changes?</a></li></ul></li><li><a href="#syntax" class="table-of-contents__link toc-highlight">Syntax</a><ul><li><a href="#markdown" class="table-of-contents__link toc-highlight">Markdown</a></li><li><a href="#tab" class="table-of-contents__link toc-highlight">Tab</a></li><li><a href="#code-blocks" class="table-of-contents__link toc-highlight">Code blocks</a></li><li><a href="#admonitions" class="table-of-contents__link toc-highlight">Admonitions</a></li><li><a href="#assets" class="table-of-contents__link toc-highlight">Assets</a></li><li><a href="#indentation-and-space" class="table-of-contents__link toc-highlight">Indentation and space</a></li><li><a href="#metadata" class="table-of-contents__link toc-highlight">Metadata</a></li><li><a href="#tables" class="table-of-contents__link toc-highlight">Tables</a></li><li><a href="#links" class="table-of-contents__link toc-highlight">Links</a></li><li><a href="#authoritative-sources" class="table-of-contents__link toc-highlight">Authoritative sources</a></li><li><a href="#escape" class="table-of-contents__link toc-highlight">Escape</a></li><li><a href="#headings" class="table-of-contents__link toc-highlight">Headings</a></li></ul></li></ul></div></div></div></div></main></div></div><footer class="footer"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title"></div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.apache.org/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Foundation<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://www.apache.org/events/current-event.html" target="_blank" rel="noopener noreferrer" class="footer__link-item">Events<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title"></div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.apache.org/licenses/" target="_blank" rel="noopener noreferrer" class="footer__link-item">License<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://www.apache.org/foundation/thanks" target="_blank" rel="noopener noreferrer" class="footer__link-item">Thanks<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://www.apache.org/foundation/sponsorship" target="_blank" rel="noopener noreferrer" class="footer__link-item">Sponsorship<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title"></div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/security/">Security</a></li><li class="footer__item"><a href="https://www.apache.org/foundation/policies/privacy.html" target="_blank" rel="noopener noreferrer" class="footer__link-item">Privacy<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/contact/">Contact</a></li></ul></div><div class="col footer__col"><div class="footer__title"></div><ul class="footer__items clean-list"><li class="footer__item"> |
