12 KiB
| id | title | description | slug |
|---|---|---|---|
| introduction | Introduction | Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly. | / |
⚡️ 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).
Fast Track ⏱️
Understand Docusaurus in 5 minutes by playing!
Create a new Docusaurus site and follow the very short embedded tutorial.
Install Node.js and create a new Docusaurus site:
npx create-docusaurus@latest my-website classic
Start the site:
cd my-website
npx docusaurus start
Open http://localhost:3000 and follow the tutorial.
:::tip
Use docusaurus.new to test Docusaurus immediately in your browser!
Or read the 5-minute tutorial online.
:::
Docusaurus: Documentation Made Easy
In this presentation at Algolia Community Event, Meta Open Source team shared a brief walk-through of Docusaurus. They covered how to get started with the project, enable plugins, and set up functionalities like documentation and blogging.