Skip to content

Docusaurus

September 29, 2023
February 28, 2023

Build optimized websites quickly, focus on your content | Docusaurus MDX + React
Markdown Features | Docusaurus
docusaurus - CodeSandbox

Admonitions | Docusaurus

Sidebar | Docusaurus
docusaurus/sidebars.js at main 路 facebook/docusaurus
docusaurus/website/docs at main 路 facebook/docusaurus

I would recommend using file name (1-topic.md) for sidebar order rather than using frontmatter.

Customization

Infima | Infima bundled CSS framework
Styling and Layout | Docusaurus

Swizzling | Docusaurus
docusaurus/packages/docusaurus-theme-classic/src/theme at main 路 facebook/docusaurus components available in default theme

Variables in MDX: frontMatter, metadata
Feature: referencing variables from markdown pages (placeholder substitution) 路 Issue #395 路 facebook/docusaurus
Interpolate variables in the MDX 路 Issue #5700 路 facebook/docusaurus

yarn run swizzle @docusaurus/theme-classic -- --list
馃檹 Report your customization use-cases 馃檹 路 Discussion #5468 路 facebook/docusaurus

Docusaurus themes | Docusaurus
Theme gallery 路 Issue #3522 路 facebook/docusaurus

Access to docs metadata from individual doc pages 路 Issue #6302 路 facebook/docusaurus add frontmatter to docs data

Ecosystem/Plugins

Awesome Resources | Docusaurus
webbertakken/awesome-docusaurus: A curated list of awesome Docusaurus resources.

kohheepeace/mr-pdf: Generate PDF for document website.

馃摝 plugin-content-docs | Docusaurus
馃摝 plugin-content-blog | Docusaurus
馃摝 plugin-content-pages | Docusaurus
馃摝 plugin-debug | Docusaurus http://localhost:3000/__docusaurus/debug

Examples

Docusaurus Site Showcase | Docusaurus
docusaurus/website at main 路 facebook/docusaurus
create-react-app/docusaurus/website at main 路 facebook/create-react-app
redux/website at master 路 reduxjs/redux
hiukim/mind-ar-js-doc: Documentation of mind-ar-js