mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-05 21:27:24 +02:00
1 line
No EOL
32 KiB
JavaScript
1 line
No EOL
32 KiB
JavaScript
"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([["11489"],{67136:function(e){e.exports=JSON.parse('{"version":{"pluginId":"default","version":"current","label":"Canary \uD83D\uDEA7","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"docs":[{"type":"link","label":"Introduction","href":"/docs/","docId":"introduction","unlisted":false},{"type":"category","label":"Getting Started","collapsed":false,"items":[{"type":"link","label":"Installation","href":"/docs/installation","docId":"installation","unlisted":false},{"type":"link","label":"Configuration","href":"/docs/configuration","docId":"configuration","unlisted":false},{"type":"link","label":"Playground","href":"/docs/playground","docId":"playground","unlisted":false},{"type":"link","label":"TypeScript Support","href":"/docs/typescript-support","docId":"typescript-support","unlisted":false}],"collapsible":true,"href":"/docs/category/getting-started"},{"type":"category","label":"Guides","items":[{"type":"link","label":"Pages","href":"/docs/creating-pages","docId":"guides/creating-pages","unlisted":false},{"type":"category","label":"Docs","items":[{"type":"link","label":"Create a doc","href":"/docs/create-doc","docId":"guides/docs/create-doc","unlisted":false},{"type":"category","label":"Sidebar","items":[{"type":"link","label":"Sidebar items","href":"/docs/sidebar/items","docId":"guides/docs/sidebar/items","unlisted":false},{"type":"link","label":"Autogenerated","href":"/docs/sidebar/autogenerated","docId":"guides/docs/sidebar/autogenerated","unlisted":false},{"type":"link","label":"Using multiple sidebars","href":"/docs/sidebar/multiple-sidebars","docId":"guides/docs/sidebar/multiple-sidebars","unlisted":false}],"collapsed":true,"collapsible":true,"href":"/docs/sidebar"},{"type":"link","label":"Versioning","href":"/docs/versioning","docId":"guides/docs/versioning","unlisted":false},{"type":"link","label":"Docs Multi-instance","href":"/docs/docs-multi-instance","docId":"guides/docs/multi-instance","unlisted":false}],"collapsed":true,"collapsible":true,"href":"/docs/docs-introduction"},{"type":"link","label":"Blog","href":"/docs/blog","docId":"blog","unlisted":false},{"type":"category","label":"Markdown Features","items":[{"type":"link","label":"MDX and React","href":"/docs/markdown-features/react","docId":"guides/markdown-features/react","unlisted":false},{"type":"link","label":"Tabs","href":"/docs/markdown-features/tabs","docId":"guides/markdown-features/tabs","unlisted":false},{"type":"link","label":"Code blocks","href":"/docs/markdown-features/code-blocks","docId":"guides/markdown-features/code-blocks","unlisted":false},{"type":"link","label":"Admonitions","href":"/docs/markdown-features/admonitions","docId":"guides/markdown-features/admonitions","unlisted":false},{"type":"link","label":"Headings and Table of contents","href":"/docs/markdown-features/toc","docId":"guides/markdown-features/toc","unlisted":false},{"type":"link","label":"Assets","href":"/docs/markdown-features/assets","docId":"guides/markdown-features/assets","unlisted":false},{"type":"link","label":"Markdown links","href":"/docs/markdown-features/links","docId":"guides/markdown-features/links","unlisted":false},{"type":"link","label":"MDX Plugins","href":"/docs/markdown-features/plugins","docId":"guides/markdown-features/plugins","unlisted":false},{"type":"link","label":"Math Equations","href":"/docs/markdown-features/math-equations","docId":"guides/markdown-features/math-equations","unlisted":false},{"type":"link","label":"Diagrams","href":"/docs/markdown-features/diagrams","docId":"guides/markdown-features/diagrams","unlisted":false},{"type":"link","label":"Head metadata","href":"/docs/markdown-features/head-metadata","docId":"guides/markdown-features/head-metadata","unlisted":false}],"collapsed":true,"collapsible":true,"href":"/docs/markdown-features"},{"type":"link","label":"Styling and Layout","href":"/docs/styling-layout","docId":"styling-layout","unlisted":false},{"type":"link","label":"Swizzling","href":"/docs/swizzling","docId":"swizzling","unlisted":false},{"type":"link","label":"Static Assets","href":"/docs/static-assets","docId":"static-assets","unlisted":false},{"type":"link","label":"Search","href":"/docs/search","docId":"search","unlisted":false},{"type":"link","label":"Browser support","href":"/docs/browser-support","docId":"browser-support","unlisted":false},{"type":"link","label":"SEO","href":"/docs/seo","docId":"seo","unlisted":false},{"type":"link","label":"Using Plugins","href":"/docs/using-plugins","docId":"using-plugins","unlisted":false},{"type":"link","label":"Deployment","href":"/docs/deployment","docId":"deployment","unlisted":false},{"type":"category","label":"Internationalization","items":[{"type":"link","label":"Tutorial","href":"/docs/i18n/tutorial","docId":"i18n/tutorial","unlisted":false},{"type":"link","label":"Using Git","href":"/docs/i18n/git","docId":"i18n/git","unlisted":false},{"type":"link","label":"Using Crowdin","href":"/docs/i18n/crowdin","docId":"i18n/crowdin","unlisted":false}],"collapsed":true,"collapsible":true,"href":"/docs/i18n/introduction"},{"type":"link","label":"What\'s next?","href":"/docs/guides/whats-next","docId":"guides/whats-next","unlisted":false}],"collapsed":true,"collapsible":true,"href":"/docs/category/guides"},{"type":"category","label":"Advanced Guides","items":[{"type":"link","label":"Architecture","href":"/docs/advanced/architecture","docId":"advanced/architecture","unlisted":false},{"type":"link","label":"Plugins","href":"/docs/advanced/plugins","docId":"advanced/plugins","unlisted":false},{"type":"link","label":"Routing","href":"/docs/advanced/routing","docId":"advanced/routing","unlisted":false},{"type":"link","label":"Static site generation","href":"/docs/advanced/ssg","docId":"advanced/ssg","unlisted":false},{"type":"link","label":"Client architecture","href":"/docs/advanced/client","docId":"advanced/client","unlisted":false}],"collapsed":true,"collapsible":true,"href":"/docs/advanced/"},{"type":"category","label":"Upgrading","items":[{"type":"link","label":"To Docusaurus v3","href":"/docs/migration/v3","docId":"migration/v3","unlisted":false},{"type":"category","label":"To Docusaurus v2","items":[{"type":"link","label":"Overview","href":"/docs/migration/v2","docId":"migration/v2/migration-overview","unlisted":false},{"type":"link","label":"Automated migration","href":"/docs/migration/v2/automated","docId":"migration/v2/migration-automated","unlisted":false},{"type":"link","label":"Manual migration","href":"/docs/migration/v2/manual","docId":"migration/v2/migration-manual","unlisted":false},{"type":"link","label":"Versioned sites","href":"/docs/migration/v2/versioned-sites","docId":"migration/v2/migration-versioned-sites","unlisted":false},{"type":"link","label":"Translated sites","href":"/docs/migration/v2/translated-sites","docId":"migration/v2/migration-translated-sites","unlisted":false}],"collapsed":true,"collapsible":true}],"collapsed":true,"collapsible":true,"href":"/docs/migration"}],"api":[{"type":"link","label":"CLI","href":"/docs/cli","docId":"cli","unlisted":false},{"type":"link","label":"Client API","href":"/docs/docusaurus-core","docId":"docusaurus-core","unlisted":false},{"type":"link","label":"docusaurus.config.js","href":"/docs/api/docusaurus-config","docId":"api/docusaurus.config.js","unlisted":false},{"type":"category","label":"Plugin method references","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Lifecycle APIs","href":"/docs/api/plugin-methods/lifecycle-apis","docId":"api/plugin-methods/lifecycle-apis","unlisted":false},{"type":"link","label":"Extending infrastructure","href":"/docs/api/plugin-methods/extend-infrastructure","docId":"api/plugin-methods/extend-infrastructure","unlisted":false},{"type":"link","label":"I18n lifecycles","href":"/docs/api/plugin-methods/i18n-lifecycles","docId":"api/plugin-methods/i18n-lifecycles","unlisted":false},{"type":"link","label":"Static methods","href":"/docs/api/plugin-methods/static-methods","docId":"api/plugin-methods/static-methods","unlisted":false}],"href":"/docs/api/plugin-methods/"},{"type":"category","label":"Plugins","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"\uD83D\uDCE6 plugin-content-docs","href":"/docs/api/plugins/@docusaurus/plugin-content-docs","docId":"api/plugins/plugin-content-docs","unlisted":false},{"type":"link","label":"\uD83D\uDCE6 plugin-content-blog","href":"/docs/api/plugins/@docusaurus/plugin-content-blog","docId":"api/plugins/plugin-content-blog","unlisted":false},{"type":"link","label":"\uD83D\uDCE6 plugin-content-pages","href":"/docs/api/plugins/@docusaurus/plugin-content-pages","docId":"api/plugins/plugin-content-pages","unlisted":false},{"type":"link","label":"\uD83D\uDCE6 plugin-client-redirects","href":"/docs/api/plugins/@docusaurus/plugin-client-redirects","docId":"api/plugins/plugin-client-redirects","unlisted":false},{"type":"link","label":"\uD83D\uDCE6 plugin-debug","href":"/docs/api/plugins/@docusaurus/plugin-debug","docId":"api/plugins/plugin-debug","unlisted":false},{"type":"link","label":"\uD83D\uDCE6 plugin-google-analytics","href":"/docs/api/plugins/@docusaurus/plugin-google-analytics","docId":"api/plugins/plugin-google-analytics","unlisted":false},{"type":"link","label":"\uD83D\uDCE6 plugin-google-gtag","href":"/docs/api/plugins/@docusaurus/plugin-google-gtag","docId":"api/plugins/plugin-google-gtag","unlisted":false},{"type":"link","label":"\uD83D\uDCE6 plugin-rsdoctor","href":"/docs/api/plugins/@docusaurus/plugin-rsdoctor","docId":"api/plugins/plugin-rsdoctor","unlisted":false},{"type":"link","label":"\uD83D\uDCE6 plugin-google-tag-manager","href":"/docs/api/plugins/@docusaurus/plugin-google-tag-manager","docId":"api/plugins/plugin-google-tag-manager","unlisted":false},{"type":"link","label":"\uD83D\uDCE6 plugin-ideal-image","href":"/docs/api/plugins/@docusaurus/plugin-ideal-image","docId":"api/plugins/plugin-ideal-image","unlisted":false},{"type":"link","label":"\uD83D\uDCE6 plugin-pwa","href":"/docs/api/plugins/@docusaurus/plugin-pwa","docId":"api/plugins/plugin-pwa","unlisted":false},{"type":"link","label":"\uD83D\uDCE6 plugin-sitemap","href":"/docs/api/plugins/@docusaurus/plugin-sitemap","docId":"api/plugins/plugin-sitemap","unlisted":false},{"type":"link","label":"\uD83D\uDCE6 plugin-vercel-analytics","href":"/docs/api/plugins/@docusaurus/plugin-vercel-analytics","docId":"api/plugins/plugin-vercel-analytics","unlisted":false}],"href":"/docs/api/plugins"},{"type":"category","label":"Themes","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Configuration","href":"/docs/api/themes/configuration","docId":"api/themes/theme-configuration","unlisted":false},{"type":"link","label":"\uD83D\uDCE6 theme-classic","href":"/docs/api/themes/@docusaurus/theme-classic","docId":"api/themes/theme-classic","unlisted":false},{"type":"link","label":"\uD83D\uDCE6 theme-live-codeblock","href":"/docs/api/themes/@docusaurus/theme-live-codeblock","docId":"api/themes/theme-live-codeblock","unlisted":false},{"type":"link","label":"\uD83D\uDCE6 theme-search-algolia","href":"/docs/api/themes/@docusaurus/theme-search-algolia","docId":"api/themes/theme-search-algolia","unlisted":false},{"type":"link","label":"\uD83D\uDCE6 theme-mermaid","href":"/docs/api/themes/@docusaurus/theme-mermaid","docId":"api/themes/theme-mermaid","unlisted":false}],"href":"/docs/api/themes"},{"type":"category","label":"Miscellaneous","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"\uD83D\uDCE6 create-docusaurus","href":"/docs/api/misc/create-docusaurus","docId":"api/misc/create-docusaurus","unlisted":false},{"type":"category","label":"\uD83D\uDCE6 eslint-plugin","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"no-html-links","href":"/docs/api/misc/@docusaurus/eslint-plugin/no-html-links","docId":"api/misc/eslint-plugin/no-html-links","unlisted":false},{"type":"link","label":"no-untranslated-text","href":"/docs/api/misc/@docusaurus/eslint-plugin/no-untranslated-text","docId":"api/misc/eslint-plugin/no-untranslated-text","unlisted":false},{"type":"link","label":"prefer-docusaurus-heading","href":"/docs/api/misc/@docusaurus/eslint-plugin/prefer-docusaurus-heading","docId":"api/misc/eslint-plugin/prefer-docusaurus-heading","unlisted":false},{"type":"link","label":"string-literal-i18n-messages","href":"/docs/api/misc/@docusaurus/eslint-plugin/string-literal-i18n-messages","docId":"api/misc/eslint-plugin/string-literal-i18n-messages","unlisted":false}],"href":"/docs/api/misc/@docusaurus/eslint-plugin"},{"type":"link","label":"\uD83D\uDCE6 logger","href":"/docs/api/misc/@docusaurus/logger","docId":"api/misc/logger/logger","unlisted":false}]}]},"docs":{"advanced/architecture":{"id":"advanced/architecture","title":"Architecture","description":"How Docusaurus works to build your app","sidebar":"docs"},"advanced/client":{"id":"advanced/client","title":"Client architecture","description":"How the Docusaurus client is structured","sidebar":"docs"},"advanced/index":{"id":"advanced/index","title":"Advanced Tutorials","description":"This section is not going to be very structured, but we will cover the following topics:","sidebar":"docs"},"advanced/plugins":{"id":"advanced/plugins","title":"Plugins","description":"Plugins are the building blocks of features in a Docusaurus site. Each plugin handles its own individual feature. Plugins may work and be distributed as part of a bundle via presets.","sidebar":"docs"},"advanced/routing":{"id":"advanced/routing","title":"Routing","description":"Docusaurus\' routing system follows single-page application conventions: one route, one component.","sidebar":"docs"},"advanced/ssg":{"id":"advanced/ssg","title":"Static site generation (SSG)","description":"Docusaurus statically renders your React code into HTML, allowing faster load speed and better SEO.","sidebar":"docs"},"api/docusaurus.config.js":{"id":"api/docusaurus.config.js","title":"docusaurus.config.js","description":"API reference for Docusaurus configuration file.","sidebar":"api"},"api/misc/create-docusaurus":{"id":"api/misc/create-docusaurus","title":"\uD83D\uDCE6 create-docusaurus","description":"A scaffolding utility to help you instantly set up a functional Docusaurus app.","sidebar":"api"},"api/misc/eslint-plugin/no-html-links":{"id":"api/misc/eslint-plugin/no-html-links","title":"no-html-links","description":"Ensure that the Docusaurus ` component is used instead of ` tags.","sidebar":"api"},"api/misc/eslint-plugin/no-untranslated-text":{"id":"api/misc/eslint-plugin/no-untranslated-text","title":"no-untranslated-text","description":"Enforce text labels in JSX to be wrapped by translate calls.","sidebar":"api"},"api/misc/eslint-plugin/prefer-docusaurus-heading":{"id":"api/misc/eslint-plugin/prefer-docusaurus-heading","title":"prefer-docusaurus-heading","description":"Ensures that the @theme/Heading theme component provided by Docusaurus theme-classic is used instead of `` tags for headings.","sidebar":"api"},"api/misc/eslint-plugin/README":{"id":"api/misc/eslint-plugin/README","title":"\uD83D\uDCE6 eslint-plugin","description":"ESLint is a tool that statically analyzes your code and reports problems or suggests best practices through editor hints and command line. Docusaurus provides an ESLint plugin to enforce best Docusaurus practices.","sidebar":"api"},"api/misc/eslint-plugin/string-literal-i18n-messages":{"id":"api/misc/eslint-plugin/string-literal-i18n-messages","title":"string-literal-i18n-messages","description":"Enforce translate APIs to be called on plain text labels.","sidebar":"api"},"api/misc/logger/logger":{"id":"api/misc/logger/logger","title":"\uD83D\uDCE6 logger","description":"An encapsulated logger for semantically formatting console messages.","sidebar":"api"},"api/plugin-methods/extend-infrastructure":{"id":"api/plugin-methods/extend-infrastructure","title":"Extending infrastructure","description":"Docusaurus has some infrastructure like hot reloading, CLI, and swizzling, that can be extended by external plugins.","sidebar":"api"},"api/plugin-methods/i18n-lifecycles":{"id":"api/plugin-methods/i18n-lifecycles","title":"I18n lifecycles","description":"Plugins use these lifecycles to load i18n-related data.","sidebar":"api"},"api/plugin-methods/lifecycle-apis":{"id":"api/plugin-methods/lifecycle-apis","title":"Lifecycle APIs","description":"During the build, plugins are loaded in parallel to fetch their own contents and render them to routes. Plugins may also configure webpack or post-process the generated files.","sidebar":"api"},"api/plugin-methods/README":{"id":"api/plugin-methods/README","title":"Plugin Method References","description":"This section is a work in progress. Anchor links or even URLs are not guaranteed to be stable.","sidebar":"api"},"api/plugin-methods/static-methods":{"id":"api/plugin-methods/static-methods","title":"Static methods","description":"Static methods are not part of the plugin instance\u2014they are attached to the constructor function. These methods are used to validate and normalize the plugin options and theme config, which are then used as constructor parameters to initialize the plugin instance.","sidebar":"api"},"api/plugins/plugin-client-redirects":{"id":"api/plugins/plugin-client-redirects","title":"\uD83D\uDCE6 plugin-client-redirects","description":"Docusaurus Plugin to generate client-side redirects.","sidebar":"api"},"api/plugins/plugin-content-blog":{"id":"api/plugins/plugin-content-blog","title":"\uD83D\uDCE6 plugin-content-blog","description":"Provides the Blog feature and is the default blog plugin for Docusaurus.","sidebar":"api"},"api/plugins/plugin-content-docs":{"id":"api/plugins/plugin-content-docs","title":"\uD83D\uDCE6 plugin-content-docs","description":"Provides the Docs functionality and is the default docs plugin for Docusaurus.","sidebar":"api"},"api/plugins/plugin-content-pages":{"id":"api/plugins/plugin-content-pages","title":"\uD83D\uDCE6 plugin-content-pages","description":"The default pages plugin for Docusaurus. The classic template ships with this plugin with default configurations. This plugin provides creating pages functionality.","sidebar":"api"},"api/plugins/plugin-debug":{"id":"api/plugins/plugin-debug","title":"\uD83D\uDCE6 plugin-debug","description":"The debug plugin will display useful debug information at http3000/docusaurus/debug.","sidebar":"api"},"api/plugins/plugin-google-analytics":{"id":"api/plugins/plugin-google-analytics","title":"\uD83D\uDCE6 plugin-google-analytics","description":"The default Google Analytics plugin. It is a JavaScript library for measuring how users interact with your website in the production build. If you are using Google Analytics 4 you might need to consider using plugin-google-gtag instead.","sidebar":"api"},"api/plugins/plugin-google-gtag":{"id":"api/plugins/plugin-google-gtag","title":"\uD83D\uDCE6 plugin-google-gtag","description":"The default Global Site Tag (gtag.js) plugin. It is a JavaScript tagging framework and API that allows you to send event data to Google Analytics, Google Ads, and Google Marketing Platform. This section describes how to configure a Docusaurus site to enable global site tag for Google Analytics.","sidebar":"api"},"api/plugins/plugin-google-tag-manager":{"id":"api/plugins/plugin-google-tag-manager","title":"\uD83D\uDCE6 plugin-google-tag-manager","description":"A plugin for adding Google Tag Manager (gtm.js) to a Docusaurus site. Use this plugin in conjunction with the standard gtag plugin for in-depth analysis of how users are using your site.","sidebar":"api"},"api/plugins/plugin-ideal-image":{"id":"api/plugins/plugin-ideal-image","title":"\uD83D\uDCE6 plugin-ideal-image","description":"Docusaurus Plugin to generate an almost ideal image (responsive, lazy-loading, and low quality placeholder).","sidebar":"api"},"api/plugins/plugin-pwa":{"id":"api/plugins/plugin-pwa","title":"\uD83D\uDCE6 plugin-pwa","description":"Docusaurus Plugin to add PWA support using Workbox. This plugin generates a Service Worker in production build only, and allows you to create fully PWA-compliant documentation site with offline and installation support.","sidebar":"api"},"api/plugins/plugin-rsdoctor":{"id":"api/plugins/plugin-rsdoctor","title":"\uD83D\uDCE6 plugin-rsdoctor","description":"A Rsdoctor plugin can help you troubleshoot the bundling phase of your Docusaurus site, supporting both Webpack and Rspack.","sidebar":"api"},"api/plugins/plugin-sitemap":{"id":"api/plugins/plugin-sitemap","title":"\uD83D\uDCE6 plugin-sitemap","description":"This plugin creates sitemaps for your site so that search engine crawlers can crawl your site more accurately.","sidebar":"api"},"api/plugins/plugin-vercel-analytics":{"id":"api/plugins/plugin-vercel-analytics","title":"\uD83D\uDCE6 plugin-vercel-analytics","description":"Vercel Analytics provides comprehensive insights into your website\'s visitors, tracking top pages, referrers, and demographics like location, operating systems, and browser info.","sidebar":"api"},"api/plugins/plugins-overview":{"id":"api/plugins/plugins-overview","title":"Docusaurus plugins","description":"We provide official Docusaurus plugins.","sidebar":"api"},"api/themes/theme-classic":{"id":"api/themes/theme-classic","title":"\uD83D\uDCE6 theme-classic","description":"The classic theme for Docusaurus.","sidebar":"api"},"api/themes/theme-configuration":{"id":"api/themes/theme-configuration","title":"Theme configuration","description":"This configuration applies to all main themes.","sidebar":"api"},"api/themes/theme-live-codeblock":{"id":"api/themes/theme-live-codeblock","title":"\uD83D\uDCE6 theme-live-codeblock","description":"This theme provides a @theme/CodeBlock component that is powered by react-live. You can read more on interactive code editor documentation.","sidebar":"api"},"api/themes/theme-mermaid":{"id":"api/themes/theme-mermaid","title":"\uD83D\uDCE6 theme-mermaid","description":"This theme provides a @theme/Mermaid component that is powered by mermaid. You can read more on diagrams documentation.","sidebar":"api"},"api/themes/theme-search-algolia":{"id":"api/themes/theme-search-algolia","title":"\uD83D\uDCE6 theme-search-algolia","description":"This theme provides a @theme/SearchBar component that integrates with Algolia DocSearch easily. Combined with @docusaurus/theme-classic, it provides a very easy search integration. You can read more on search documentation.","sidebar":"api"},"api/themes/themes-overview":{"id":"api/themes/themes-overview","title":"Docusaurus themes","description":"We provide official Docusaurus themes.","sidebar":"api"},"blog":{"id":"blog","title":"Blog","description":"Deploy a full-featured blog in no time with Docusaurus.","sidebar":"docs"},"browser-support":{"id":"browser-support","title":"Browser support","description":"How to keep a reasonable bundle size while ensuring sufficient browser support.","sidebar":"docs"},"cli":{"id":"cli","title":"CLI","description":"Docusaurus provides a set of scripts to help you generate, serve, and deploy your website.","sidebar":"api"},"configuration":{"id":"configuration","title":"Configuration","description":"Configuring your site\'s behavior through docusaurus.config.js and more.","sidebar":"docs"},"deployment":{"id":"deployment","title":"Deployment","description":"Deploy your Docusaurus app for production on a range of static site hosting services.","sidebar":"docs"},"docusaurus-core":{"id":"docusaurus-core","title":"Docusaurus Client API","description":"Docusaurus provides some APIs on the clients that can be helpful to you when building your site.","sidebar":"api"},"guides/creating-pages":{"id":"guides/creating-pages","title":"Creating Pages","description":"In this section, we will learn about creating pages in Docusaurus.","sidebar":"docs"},"guides/docs/create-doc":{"id":"guides/docs/create-doc","title":"Create a doc","description":"Create a Markdown Document","sidebar":"docs"},"guides/docs/introduction":{"id":"guides/docs/introduction","title":"Docs Introduction","description":"The docs feature provides users with a way to organize Markdown files in a hierarchical format.","sidebar":"docs"},"guides/docs/multi-instance":{"id":"guides/docs/multi-instance","title":"Docs Multi-instance","description":"Use multiple docs plugin instances on a single Docusaurus site.","sidebar":"docs"},"guides/docs/sidebar/autogenerated":{"id":"guides/docs/sidebar/autogenerated","title":"Autogenerated","description":"Docusaurus can create a sidebar automatically from your filesystem structure: each folder creates a sidebar category, and each file creates a doc link.","sidebar":"docs"},"guides/docs/sidebar/index":{"id":"guides/docs/sidebar/index","title":"Sidebar","description":"Creating a sidebar is useful to:","sidebar":"docs"},"guides/docs/sidebar/items":{"id":"guides/docs/sidebar/items","title":"Sidebar items","description":"We have introduced three types of item types in the example in the previous section autogenerated, which we will explain in detail later.","sidebar":"docs"},"guides/docs/sidebar/multiple-sidebars":{"id":"guides/docs/sidebar/multiple-sidebars","title":"Using multiple sidebars","description":"You can create a sidebar for each set of Markdown files that you want to group together.","sidebar":"docs"},"guides/docs/versioning":{"id":"guides/docs/versioning","title":"Versioning","description":"You can use the versioning CLI to create a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory continues to evolve.","sidebar":"docs"},"guides/markdown-features/admonitions":{"id":"guides/markdown-features/admonitions","title":"Admonitions","description":"Handling admonitions/callouts in Docusaurus Markdown","sidebar":"docs"},"guides/markdown-features/assets":{"id":"guides/markdown-features/assets","title":"Assets","description":"Handling assets in Docusaurus Markdown","sidebar":"docs"},"guides/markdown-features/code-blocks":{"id":"guides/markdown-features/code-blocks","title":"Code blocks","description":"Handling code blocks in Docusaurus Markdown","sidebar":"docs"},"guides/markdown-features/diagrams":{"id":"guides/markdown-features/diagrams","title":"Diagrams","description":"Writing diagrams with Mermaid","sidebar":"docs"},"guides/markdown-features/head-metadata":{"id":"guides/markdown-features/head-metadata","title":"Head metadata","description":"Declaring page-specific head metadata through MDX","sidebar":"docs"},"guides/markdown-features/introduction":{"id":"guides/markdown-features/introduction","title":"Markdown Features","description":"Docusaurus uses MDX. Find out more about Docusaurus-specific features when writing Markdown.","sidebar":"docs"},"guides/markdown-features/links":{"id":"guides/markdown-features/links","title":"Markdown links","description":"Links to other pages in Markdown","sidebar":"docs"},"guides/markdown-features/math-equations":{"id":"guides/markdown-features/math-equations","title":"Math Equations","description":"Writing LaTeX Math Equations","sidebar":"docs"},"guides/markdown-features/plugins":{"id":"guides/markdown-features/plugins","title":"MDX Plugins","description":"Using MDX plugins to expand Docusaurus Markdown functionalities","sidebar":"docs"},"guides/markdown-features/react":{"id":"guides/markdown-features/react","title":"MDX and React","description":"Using the power of React in Docusaurus Markdown documents, thanks to MDX","sidebar":"docs"},"guides/markdown-features/tabs":{"id":"guides/markdown-features/tabs","title":"Tabs","description":"Using tabs inside Docusaurus Markdown","sidebar":"docs"},"guides/markdown-features/toc":{"id":"guides/markdown-features/toc","title":"Headings and Table of contents","description":"Customizing headings and table-of-contents in Markdown","sidebar":"docs"},"guides/whats-next":{"id":"guides/whats-next","title":"What\'s next?","description":"Congratulations! You have understood most core features of Docusaurus now. You have:","sidebar":"docs"},"i18n/crowdin":{"id":"i18n/crowdin","title":"i18n - Using Crowdin","description":"The i18n system of Docusaurus is decoupled from any translation software.","sidebar":"docs"},"i18n/git":{"id":"i18n/git","title":"i18n - Using git","description":"A possible translation strategy is to version control the translation files with Git (or any other VCS).","sidebar":"docs"},"i18n/introduction":{"id":"i18n/introduction","title":"i18n - Introduction","description":"It is easy to translate a Docusaurus website with its internationalization (i18n) support.","sidebar":"docs"},"i18n/tutorial":{"id":"i18n/tutorial","title":"i18n - Tutorial","description":"This tutorial will walk you through the basics of the Docusaurus i18n system.","sidebar":"docs"},"installation":{"id":"installation","title":"Installation","description":"How to install Docusaurus locally, and start a Docusaurus site in no time.","sidebar":"docs"},"introduction":{"id":"introduction","title":"Introduction","description":"Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.","sidebar":"docs"},"migration/index":{"id":"migration/index","title":"Upgrading Docusaurus","description":"Docusaurus versioning is based on the major.minor.patch scheme and respects Semantic Versioning.","sidebar":"docs"},"migration/v2/migration-automated":{"id":"migration/v2/migration-automated","title":"Automated migration","description":"The migration CLI automatically migrates your v1 website to a v2 website.","sidebar":"docs"},"migration/v2/migration-manual":{"id":"migration/v2/migration-manual","title":"Manual migration","description":"This manual migration process should be run after the automated migration process, to complete the missing parts, or debug issues in the migration CLI output.","sidebar":"docs"},"migration/v2/migration-overview":{"id":"migration/v2/migration-overview","title":"Overview","description":"This doc guides you through migrating an existing Docusaurus 1 site to Docusaurus 2.","sidebar":"docs"},"migration/v2/migration-translated-sites":{"id":"migration/v2/migration-translated-sites","title":"Translated sites","description":"This page explains how migrate a translated Docusaurus v1 site to Docusaurus v2.","sidebar":"docs"},"migration/v2/migration-versioned-sites":{"id":"migration/v2/migration-versioned-sites","title":"Versioned sites","description":"Read up https://docusaurus.io/blog/2018/09/11/Towards-Docusaurus-2#versioning first for problems in v1\'s approach.","sidebar":"docs"},"migration/v3":{"id":"migration/v3","title":"Upgrading to Docusaurus v3","description":"This documentation will help you upgrade your site from Docusaurus v2 to Docusaurus v3.","sidebar":"docs"},"playground":{"id":"playground","title":"Playground","description":"Playgrounds allow you to run Docusaurus in your browser, without installing anything!","sidebar":"docs"},"search":{"id":"search","title":"Search","description":"There are a few options you can use to add search to your website:","sidebar":"docs"},"seo":{"id":"seo","title":"Search engine optimization (SEO)","description":"How to make your Docusaurus site maximally search-engine-friendly.","sidebar":"docs"},"static-assets":{"id":"static-assets","title":"Static Assets","description":"Static assets are the non-code files that are directly copied to the build output. Learn about how they are handled and what the best practices of using static assets are.","sidebar":"docs"},"styling-layout":{"id":"styling-layout","title":"Styling and Layout","description":"A Docusaurus site is a pre-rendered single-page React application. You can style it the way you style React apps.","sidebar":"docs"},"swizzling":{"id":"swizzling","title":"Swizzling","description":"Customize your site\'s appearance through creating your own theme components","sidebar":"docs"},"typescript-support":{"id":"typescript-support","title":"TypeScript Support","description":"Docusaurus is written in TypeScript and provides first-class TypeScript support.","sidebar":"docs"},"using-plugins":{"id":"using-plugins","title":"Using Plugins","description":"The Docusaurus core doesn\'t provide any feature of its own. All features are delegated to individual plugins: the docs feature provided by the docs plugin; the blog feature provided by the blog plugin; or individual pages provided by the pages plugin. If there are no plugins installed, the site won\'t contain any routes.","sidebar":"docs"}}}}')}}]); |