[Docusaurus](https://docusaurus.io/) is an open-source documentation website generator. ## Features - Control publishing, slugs, tags, and more with extensive [YAML frontmatter](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs#markdown-front-matter). - Call out important information with [admonitions](https://docusaurus.io/docs/markdown-features/admonitions). ([[Obsidian|Obsidian]] refers to these as "callouts".) - Customize the styles [natively](https://docs.theochu.com/docusaurus/styling/) or with [Tailwind](https://dev.to/sajclarke_62/using-tailwindcss-v3-in-docusaurus-in-5-steps-5c26). - Write code blocks in many languages, and [add more languages](https://docusaurus.io/docs/markdown-features/code-blocks#supported-languages). - Manage content with [[Netlify|Netlify]]'s [Decap CMS](https://decapcms.org/docs/docusaurus/). ## Plugins - [Official plugins](https://docusaurus.io/docs/api/plugins) - [Community plugins](https://docusaurus.io/community/resources#community-plugins) - [[PostHog]] analytics ## Tips 🔥 [Use number prefixes](https://docusaurus.io/docs/sidebar/autogenerated#using-number-prefixes) to order files properly. ``` docs ├── 01-Intro.md ├── 02-Tutorial Easy │ ├── 01-First Part.md │ ├── 02-Second Part.md │ └── 03-End.md ├── 03-Tutorial Advanced │ ├── 01-First Part.md │ ├── 02-Second Part.md │ ├── 03-Third Part.md │ └── 04-End.md └── 04-End.md ``` Display a document in a different sidebar with the `displayed_sidebar` property. ``` --- title: Delete git branches slug: /how-to-delete-git-branches displayed_sidebar: snippetsSidebar tags: - git --- ``` Hide or show the left-hand nav bar. ```json module.exports = { themeConfig: { docs: { sidebar: { hideable: true, }, }, }, }; ``` Access the entire site's configuration with `useDocusaurusContext`. ```jsx import useDocusaurusContext from "@docusaurus/useDocusaurusContext"; ... const { siteConfig } = useDocusaurusContext(); ``` ## Resources - [CLI reference](https://docusaurus.io/docs/cli#options)