Skip to content
Agents tracked: 502 Releases (7d): 613 Agent status: 4 with issuesSince last limit reset: Claude 7d · Codex 5d For AI agents: Markdown Updated Nov 18, 2026

Docusaurus

by Meta Open Source

Open-source docs-site generator with a ready classic template (docs, blog, landing page); React + MDX.

Page and site templates Code libraryOpen sourceminimal

GitHub repoWebsite

2. Commercial use: raw.githubusercontent.com

“Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software”

MIT allows use, change and sale, including for paid products.

raw.githubusercontent.com

License checked Nov 5, 2026 against 1 official page. Tap a verdict to see its source. How we checked Report an error

Docusaurus: a docs website built from text files

Docusaurus is a free tool from Meta that turns folders of Markdown text files into a documentation website with a sidebar, a blog and extra pages. You or your AI assistant write the texts, and it builds ready web pages for any web hosting. Translations, docs for each release and dark mode are built in.

Where you can use it

Docs site for your product

Put guides, how-tos and reference pages for your app or library on one site with a sidebar. You add a page by adding a text file.

A blog next to the docs

Post release notes and articles as dated text files. The blog gets its own list page, and only the part above a marker shows as the summary.

The same docs in several languages

Offer the site in English and French, or in a right-to-left language such as Persian, with a language menu in the top bar.

Docs for each release

Keep the docs for version 1.0 readable while you write the docs for 2.0. Readers pick their version from a menu.

Landing page or personal site

Use the same tool for a product landing page, a personal site or a blog that has no docs at all.

Help center for your app users Idea

Write help articles for customers, such as how to change a plan or export data, and link to them from inside your app.

Docusaurus popularity

34 / 100
Gid Score, same scale as developer tools
66,749
GitHub stars
6,699
npm downloads, last 7 days
-36.5% in 4 weeks
Docusaurus: downloads per weeknpm, create-docusaurus 6,699
Docusaurus: GitHub starsmeta/docusaurus 66,749

Downloads from api.npmjs.org, stars from GitHub, checked Nov 17, 2026. How the Gid Score is calculated

How to start

Tell your AI assistant

“Create a Docusaurus 3.10.2 site with the classic template in a website/ folder, keep every @docusaurus package on that exact version, set url and baseUrl for our domain, and move our guides into docs/ as Markdown files.”

Or install it yourself. With Node.js 20 or newer installed, create a site from the classic template (docs, blog, pages and dark mode).

npx create-docusaurus@latest my-website classic
Show codeStep 1 or Step 2

Start the preview server; pages update as you edit the files.

cd my-website
npm run start

Mistakes to avoid

Updating only @docusaurus/core (for example to 3.10.2) and leaving @docusaurus/preset-classic on an older version
Set every @docusaurus/* package in package.json to the same exact version, then run npm install

The packages are released together and are meant to match.

url: 'https://my-org.com/my-project' with baseUrl: '/'
url: 'https://my-org.com/' and baseUrl: '/my-project/' (with the trailing slash)

Links and files load from the wrong place when the site lives in a subfolder.

Reading process.env.MY_VALUE inside a React page or MDX file
Read the variable in docusaurus.config.js, put it in customFields and read it with useDocusaurusContext()

Only the config file runs in Node.js; pages run in the browser and have no process variable.

Writing the HTML comment truncate marker in a .mdx blog post
In .mdx files use the MDX comment form {/* truncate */}; the HTML comment form is for .md files

MDX files use a different comment syntax, so the summary cut does not work.

Turning on docs versioning for a small project from day one
Add versions only when the docs change a lot between releases

Versioning makes builds slower and editing harder.

License

MIT license. License, so it is free for personal and paid sites, and your site needs no visible credit. Keep the copyright and license notice if you pass on copies of the Docusaurus code.

Commercial use
Yes

“Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software” raw.githubusercontent.com

Credit
Not needed

“The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.” raw.githubusercontent.com

Inside your app or game
Can ship inside your app

“Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software” raw.githubusercontent.com

Pass the files on to your users
Allowed

“Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software” raw.githubusercontent.com

AI training
Not stated
Bots and bulk downloads
Not stated

AllowedWith conditionsNot allowedNot stated or not checked yet

Is Docusaurus free for commercial use? The full answer Not legal advice. Check the license page before you ship.

For your agent

License rules tell your agent what it may do with Docusaurus. Paste them into your prompt or AGENTS.md.

License rules
- Docusaurus (Page and site templates). Open-source docs-site generator with a ready classic template (docs, blog, landing page); React + MDX. Price: free; commercial use OK; no credit needed. Style: minimal.
  Connect: npm create-docusaurus.
  Get files: npm init docusaurus@latest (pick the classic template); no account (mdx, jsx, css).
  Not allowed: Needs Node.js
  Rule: Keep the MIT copyright notice in the code if you redistribute it.
  Rule: No visible credit on the site is required by the licence.
  License: https://raw.githubusercontent.com/facebook/docusaurus/main/LICENSE (checked 2026-11-05; details: https://agentgid.com/assets/docusaurus/)
Can an agent use it by itself?
Yes.

Agent installs a package or loads it from a CDN.

Install
npm install create-docusaurus
How an agent gets files
npm init docusaurus@latest (pick the classic template); no account.

Formats: mdx, jsx, css

Repository
API, key or account
Not needed. Everything runs on your side.
MCP server
None found
Credit line, if you want one
Built with Docusaurus.
This card for machines

Alternatives

Docusaurus This page

Free Commercial OK npm

VitePress

Pick VitePress when your project uses Vue instead of React; the Docusaurus docs name it the Vue choice.

Free Commercial OK npm

Starlight

Pick Starlight for an Astro docs site with navigation, search, translations and dark mode ready out of the box.

Free Commercial OK npm

Nextra

Pick Nextra when your app already runs on Next.js and you want the docs in the same stack.

Free Commercial OK npm

Bootstrap Examples

Official Bootstrap 5 example snippets and layouts: heroes, features, pricing, headers, footers, dashboards; one zip download.

Free Commercial OK npm

Nuxt UI

Vue/Nuxt UI library (125+ components, Reka UI + Tailwind) with page-level components and MIT starter templates: landing, SaaS, docs, dashboard.

Free Commercial OK npm

All page and site templates

Questions

Do I need to know React to use it?

No. You write docs and blog posts as Markdown files; React is only needed to build custom pages or change the layout.

Can I use it for a paid product or a client site?

Yes. The MIT license allows use, change and sale; keep the license notice with copies of its code.

Does the finished site need a server with Node.js?

No. The build is a folder of static files, and the site generally works even without JavaScript.

Can I try it without installing anything?

Yes. The docs point to docusaurus.new, a playground that runs in the browser.

Is it only for docs?

No. It can make any kind of site, such as a personal site, a blog or a landing page.