Bunosaurus is a fork of Docusaurus (4.0 development version) that runs on Bun only and bundles sites with Bun.build() instead of Webpack/Rspack. It is a drop-in replacement: sites install the @azerion/bunosaurus-* packages under their @docusaurus/* names.
bun create @azerion/bunosaurus my-website classicImprove Digital Yield docs: ~415 Markdown files, 9 docs plugin instances, 2 blogs, 2 locales, 1208 pages. Baseline: Docusaurus 3.10 with future.faster (Rspack, SWC, LightningCSS) on Node.js 24. Median of 4 interleaved runs on an AMD Ryzen AI 9 HX 370 laptop.
| Docusaurus 3.10 (Rspack) | Bunosaurus | ||
|---|---|---|---|
| Production build, cold | 24.9s | 16.1s | -35% |
| Production build, warm cache | 15.8s | 10.0s | -37% |
| Dev server ready, cold | 8.2s | 5.1s | -38% |
| Dev server ready, warm cache | 2.1s | ||
| Dev server, rebuild after editing a doc | 0.4s (HMR) | 0.6s (hot update) |
-
Install Bun 1.4.1 or above.
-
In your site
package.json, point each@docusaurus/*dependency to its Bunosaurus package with an npm alias, so that your code and imports stay unchanged:{ "dependencies": { "@docusaurus/core": "npm:@azerion/bunosaurus-core@4.0.0", "@docusaurus/preset-classic": "npm:@azerion/bunosaurus-preset-classic@4.0.0", "react": "^19.3.0", "react-dom": "^19.3.0" } }Remove
@docusaurus/fasterand@rspack/core, and upgrade React to 19.3. -
In
docusaurus.config, removefuture.fasterandfuture.v4. -
Install and run with Bun:
bun install, thenbun run startorbun run build.
Bunosaurus is based on the Docusaurus 4.0 development version: also check its breaking changes.
See BUNOSAURUS.md for the changes compared to Docusaurus, the breaking changes, the full migration guide and the benchmark scripts.
Docusaurus is a project for building, deploying, and maintaining open source project websites easily.
Short on time? Check out our 5-minute tutorial ⏱️!
Tip: use docusaurus.new to test Docusaurus immediately in a playground.
- Simple to Start
Docusaurus is built in a way so that it can get running in as little time as possible. We've built Docusaurus to handle the website build process so you can focus on your project.
- Localizable
Docusaurus ships with localization support via CrowdIn. Empower and grow your international community by translating your documentation.
- Customizable
While Docusaurus ships with the key pages and sections you need to get started, including a home page, a docs section, a blog, and additional support pages, it is also customizable to ensure you have a site that is uniquely yours.
Use the initialization CLI to create your site:
npm init docusaurus@latestRead the docs for any further information.
We've released Docusaurus because it helps us better scale and supports the many OSS projects at Meta. We hope that other organizations can benefit from the project. We are thankful for any contributions from the community.
Meta has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.
Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Docusaurus.
To help you get your feet wet and get you familiar with our contribution process, we have a list of beginner-friendly bugs that might contain smaller issues to tackle first. This is a great place to get started.
We have a few channels for contact:
- Discord:
#generalfor those using Docusaurus.#contributorsfor those wanting to contribute to the Docusaurus core.
- @docusaurus X
- GitHub Issues
This project exists thanks to all the people who contribute. [Contribute].
Thank you to all our backers! 🙏 Become a backer
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. Become a sponsor
Docusaurus is MIT licensed.
The Docusaurus documentation (e.g., .md files in the /docs folder) is Creative Commons licensed.
BrowserStack supports us with free access for open source.
Rocket Validator helps us find HTML markup and accessibility issues.
