跳到主要内容

Intro

What is Docusaurus?​

Build optimized websites quickly, focus on your content using react and powered by MDX.

⚡️ Docusaurus will help you ship a beautiful documentation site in no time.

💸 Building a custom tech stack is expensive. Instead, focus on your content and just write Markdown files.

💥 Ready for more? Use advanced features like versioning, i18n, search and theme customizations.

💅 Check the best Docusaurus sites for inspiration and read some testimonials.

🧐 Docusaurus is a static-site generator. It builds a single-page application with fast client-side navigation, leveraging the full power of React to make your site interactive. It provides out-of-the-box documentation features but can be used to create any kind of site (personal website, product, blog, marketing landing pages, etc).

What is MDX?​

MDX lets you use JSX in your markdown content. You can import components, such as interactive charts or alerts, and embed them within your content. This makes writing long-form content with components a blast.

❤️ Powerful: MDX blends markdown and JSX syntax to fit perfectly in JSX-based projects

💻 Everything is a component: Use existing components in your MDX and import other MDX files as components

🔧 Customizable: Decide which component is rendered for each markdown construct ({h1: MyHeading})

📚 Markdown-based: The simplicity and elegance of markdown remains, you use JSX only when you want to

🔥 Blazingly blazing fast: MDX has no runtime, all compilation occurs during the build stage