# Docusaurus

> description: How Docusaurus works to build your app

## Pages

- [Architecture](advanced-architecture.md): import Tabs from '@theme/Tabs';
- [Client architecture](advanced-client.md): A theme works by exporting a set of components, e.g.`Navbar`,`Layout`,`Footer`, to render the data passed down fro...
- [Advanced Tutorials](advanced.md): This section is not going to be very structured, but we will cover the following topics:
- [Plugins](advanced-plugins.md): Plugins are the building blocks of features in a Docusaurus site. Each plugin handles its own individual feature. Plu...
- [Routing](advanced-routing.md): import Link from '@docusaurus/Link';
- [Static site generation (SSG)](advanced-ssg.md): In [architecture](architecture.mdx), we mentioned that the theme is run in Webpack. But beware: that doesn't mean it ...
- [`docusaurus.config.js`](api-docusaurusconfigjs.md): import APITable from '@site/src/components/APITable';
- [📦 create-docusaurus](api-misc-create-docusaurus.md): A scaffolding utility to help you instantly set up a functional Docusaurus app.
- [📦 eslint-plugin](api-misc-eslint-plugin-readme.md): [ESLint](https://eslint.org/) is a tool that statically analyzes your code and reports problems or suggests best prac...
- [no-html-links](api-misc-eslint-plugin-no-html-links.md): import APITable from '@site/src/components/APITable';
- [no-untranslated-text](api-misc-eslint-plugin-no-untranslated-text.md): import APITable from '@site/src/components/APITable';
- [prefer-docusaurus-heading](api-misc-eslint-plugin-prefer-docusaurus-heading.md): Ensures that the`@theme/Heading`theme component provided by Docusaurus [`theme-classic`](../../themes/theme-classic...
- [string-literal-i18n-messages](api-misc-eslint-plugin-string-literal-i18n-messages.md): Enforce translate APIs to be called on plain text labels.
- [📦 logger](api-misc-logger-logger.md): An encapsulated logger for semantically formatting console messages.
- [Plugin Method References](api-plugin-methods-readme.md): :::warning
- [Extending infrastructure](api-plugin-methods-extend-infrastructure.md): Docusaurus has some infrastructure like hot reloading, CLI, and swizzling, that can be extended by external plugins.
- [I18n lifecycles](api-plugin-methods-i18n-lifecycles.md): Plugins use these lifecycles to load i18n-related data.
- [Lifecycle APIs](api-plugin-methods-lifecycle-apis.md): During the build, plugins are loaded in parallel to fetch their own contents and render them to routes. Plugins may a...
- [Static methods](api-plugin-methods-static-methods.md): Static methods are not part of the plugin instance—they are attached to the constructor function. These methods are u...
- [A partial tag definition is also valid](api-plugins-partial-tags-file-api-ref-section.md): Use the`tags`plugin option to configure the path of a YAML tags file.
- [Docusaurus plugins](api-plugins-overview.md): We provide official Docusaurus plugins.
- [📦 plugin-client-redirects](api-plugins-plugin-client-redirects.md): import APITable from '@site/src/components/APITable';
- [📦 plugin-content-blog](api-plugins-plugin-content-blog.md): import APITable from '@site/src/components/APITable';
- [📦 plugin-content-docs](api-plugins-plugin-content-docs.md): import APITable from '@site/src/components/APITable';
- [📦 plugin-content-pages](api-plugins-plugin-content-pages.md): import APITable from '@site/src/components/APITable';
- [📦 plugin-css-cascade-layers](api-plugins-plugin-css-cascade-layers.md): import APITable from '@site/src/components/APITable';
- [📦 plugin-debug](api-plugins-plugin-debug.md): import Tabs from '@theme/Tabs';
- [📦 plugin-google-analytics](api-plugins-plugin-google-analytics.md): import APITable from '@site/src/components/APITable';
- [📦 plugin-google-gtag](api-plugins-plugin-google-gtag.md): import APITable from '@site/src/components/APITable';
- [📦 plugin-google-tag-manager](api-plugins-plugin-google-tag-manager.md): import APITable from '@site/src/components/APITable';
- [📦 plugin-ideal-image](api-plugins-plugin-ideal-image.md): import APITable from '@site/src/components/APITable';
- [📦 plugin-pwa](api-plugins-plugin-pwa.md): Docusaurus Plugin to add PWA support using [Workbox](https://developers.google.com/web/tools/workbox). This plugin ge...
- [📦 plugin-rsdoctor](api-plugins-plugin-rsdoctor.md): import APITable from '@site/src/components/APITable';
- [📦 plugin-sitemap](api-plugins-plugin-sitemap.md): import APITable from '@site/src/components/APITable';
- [📦 plugin-svgr](api-plugins-plugin-svgr.md): import APITable from '@site/src/components/APITable';
- [📦 plugin-vercel-analytics](api-plugins-plugin-vercel-analytics.md): import APITable from '@site/src/components/APITable';
- [Docusaurus themes](api-themes-overview.md): We provide official Docusaurus themes.
- [📦 theme-classic](api-themes-theme-classic.md): import APITable from '@site/src/components/APITable';
- [Theme configuration](api-themes-theme-configuration.md): import APITable from '@site/src/components/APITable';
- [📦 theme-live-codeblock](api-themes-theme-live-codeblock.md): This theme provides a`@theme/CodeBlock`component that is powered by [react-live](https://commerce.nearform.com/open...
- [📦 theme-mermaid](api-themes-theme-mermaid.md): This theme provides a`@theme/Mermaid`component that is powered by [mermaid](https://mermaid-js.github.io/). You can...
- [📦 theme-search-algolia](api-themes-theme-search-algolia.md): This theme provides a`@theme/SearchBar`component that integrates with Algolia DocSearch easily. Combined with`@doc...
- [Blog](blog.md): import Tabs from '@theme/Tabs';
- [Browser support](browser-support.md): Docusaurus allows sites to define the list of supported browsers through a [browserslist configuration](https://githu...
- [CLI](cli.md): Docusaurus provides a set of scripts to help you generate, serve, and deploy your website.
- [Configuration](configuration.md): import TOCInline from '@theme/TOCInline';
- [Deployment](deployment.md): To build the static files of your website for production, run:
- [Docusaurus Client API](docusaurus-core.md): Docusaurus provides some APIs on the clients that can be helpful to you when building your site.
- [Creating Pages](guides-creating-pages.md): In this section, we will learn about creating pages in Docusaurus.
- [Create a doc](guides-docs-docs-create-doc.md): Create a Markdown file,`greeting.md`, and place it under the`docs`directory.
- [Docs Introduction](guides-docs-docs-introduction.md): The docs feature provides users with a way to organize Markdown files in a hierarchical format.
- [Docs Multi-instance](guides-docs-docs-multi-instance.md): The`@docusaurus/plugin-content-docs`plugin can support [multi-instance](../../using-plugins.mdx#multi-instance-plug...
- [Autogenerated](guides-docs-sidebar-autogenerated.md): import Tabs from '@theme/Tabs';
- [Sidebar](guides-docs-sidebar.md): Creating a sidebar is useful to:
- [Sidebar items](guides-docs-sidebar-items.md): import Tabs from '@theme/Tabs';
- [Using multiple sidebars](guides-docs-sidebar-multiple-sidebars.md): You can create a sidebar for each **set of Markdown files** that you want to **group together**.
- [Versioning](guides-docs-versioning.md): You can use the versioning CLI to create a new documentation version based on the latest content in the`docs`direct...
- [_Markdown Partial Example](guides-markdown-features-markdown-partial-example.md): This is text some content from`_markdown-partial-example.md`.
- [Admonitions](guides-markdown-features-markdown-features-admonitions.md): import BrowserWindow from '@site/src/components/BrowserWindow';
- [Assets](guides-markdown-features-markdown-features-assets.md): import BrowserWindow from '@site/src/components/BrowserWindow';
- [Code blocks](guides-markdown-features-markdown-features-code-blocks.md): import BrowserWindow from '@site/src/components/BrowserWindow';
- [Diagrams](guides-markdown-features-markdown-features-diagrams.md): Diagrams can be rendered using [Mermaid](https://mermaid-js.github.io/mermaid/) in a code block.
- [Head metadata](guides-markdown-features-markdown-features-head-metadata.md): Docusaurus automatically sets useful page metadata in``,``and``for you. It is possible to add ...
- [Markdown Features](guides-markdown-features-markdown-features-intro.md): import BrowserWindow from '@site/src/components/BrowserWindow';
- [Markdown links](guides-markdown-features-markdown-features-links.md): There are two ways of adding a link to another page: through a **URL path** and a **file path**.
- [Math Equations](guides-markdown-features-markdown-features-math-equations.md): import BrowserWindow from '@site/src/components/BrowserWindow';
- [MDX Plugins](guides-markdown-features-markdown-features-plugins.md): Sometimes, you may want to extend or tweak your Markdown syntax. For example:
- [MDX and React](guides-markdown-features-markdown-features-react.md): import BrowserWindow from '@site/src/components/BrowserWindow';
- [Tabs](guides-markdown-features-markdown-features-tabs.md): import BrowserWindow from '@site/src/components/BrowserWindow';
- [Headings and Table of contents](guides-markdown-features-markdown-features-toc.md): import BrowserWindow from '@site/src/components/BrowserWindow';
- [What's next?](guides-whats-next.md): Congratulations! You have understood most core features of Docusaurus now. You have:
- [i18n - Using Crowdin](i18n-i18n-crowdin.md): The i18n system of Docusaurus is **decoupled from any translation software**.
- [i18n - Using git](i18n-i18n-git.md): A **possible translation strategy** is to **version control the translation files** with Git (or any other [VCS](http...
- [i18n - Introduction](i18n-i18n-introduction.md): It is **easy to translate a Docusaurus website** with its internationalization ([i18n](https://en.wikipedia.org/wiki/...
- [i18n - Tutorial](i18n-i18n-tutorial.md): import Tabs from '@theme/Tabs';
- [Installation](installation.md): import Tabs from '@theme/Tabs';
- [Introduction](introduction.md): ⚡️ Docusaurus will help you ship a **beautiful documentation site in no time**.
- [Upgrading Docusaurus](migration.md): Docusaurus versioning is based on the`major.minor.patch`scheme and respects [**Semantic Versioning**](https://semve...
- [Automated migration](migration-v2-migration-automated.md): The migration CLI automatically migrates your v1 website to a v2 website.
- [Manual migration](migration-v2-migration-manual.md): This manual migration process should be run after the [automated migration process](./migration-automated.mdx), to co...
- [Overview](migration-v2-migration-overview.md): This doc guides you through migrating an existing Docusaurus 1 site to Docusaurus 2.
- [Translated sites](migration-v2-migration-translated-sites.md): This page explains how migrate a translated Docusaurus v1 site to Docusaurus v2.
- [Versioned sites](migration-v2-migration-versioned-sites.md): Read up first for problems in v1's approach.
- [Upgrading to Docusaurus v3](migration-v3.md): This documentation will help you upgrade your site from Docusaurus v2 to Docusaurus v3.
- [Playground](playground.md): Playgrounds allow you to run Docusaurus **in your browser, without installing anything**!
- [Search](search.md): There are a few options you can use to add search to your website:
- [Search engine optimization (SEO)](seo.md): import BrowserWindow from '@site/src/components/BrowserWindow';
- [Static Assets](static-assets.md): Static assets are the non-code files that are directly copied to the build output. They include images, stylesheets, ...
- [Styling and Layout](styling-layout.md): import ColorGenerator from '@site/src/components/ColorGenerator';
- [Swizzling](swizzling.md): In this section, we will introduce how customization of layout is done in Docusaurus.
- [TypeScript Support](typescript-support.md): Docusaurus is written in TypeScript and provides first-class TypeScript support.
- [Using Plugins](using-plugins.md): **The Docusaurus core doesn't provide any feature of its own.** All features are delegated to individual plugins: the...