{
 "slug": "docusaurus",
 "name": "Docusaurus",
 "author": "Meta Open Source",
 "density": "full",
 "status": "active",
 "status_note": null,
 "alternatives_page": null,
 "one_liner": "Open-source docs-site generator with a ready classic template (docs, blog, landing page); React + MDX.",
 "category": {
  "slug": "page-templates",
  "name": "Page and site templates"
 },
 "tags": [
  "Code library",
  "Open source"
 ],
 "styles": [
  "minimal"
 ],
 "logo_url": "https://agentgid.com/media/avatars/meta.png",
 "logo_letter": "D",
 "links": {
  "repo": "https://github.com/meta/docusaurus",
  "website": "https://docusaurus.io",
  "api_docs": null
 },
 "preview": null,
 "verdicts": [
  {
   "key": "price",
   "label": "Price",
   "value": "Free",
   "status": "yes",
   "sub": "No paid plan",
   "quote": null,
   "note": "Fully free.",
   "source": {
    "label": "docusaurus.io",
    "url": "https://docusaurus.io"
   },
   "n": 1
  },
  {
   "key": "commercial",
   "label": "Commercial use",
   "value": "Yes",
   "status": "yes",
   "sub": "MIT",
   "quote": "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",
   "note": "MIT allows use, change and sale, including for paid products.",
   "source": {
    "label": "raw.githubusercontent.com",
    "url": "https://raw.githubusercontent.com/facebook/docusaurus/main/LICENSE"
   },
   "n": 2
  },
  {
   "key": "credit",
   "label": "Credit the author",
   "value": "Not needed",
   "status": "yes",
   "sub": "Keep the notice in code copies",
   "quote": "The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.",
   "note": "No credit on screen. Keep the license notice inside the code you ship.",
   "source": {
    "label": "raw.githubusercontent.com",
    "url": "https://raw.githubusercontent.com/facebook/docusaurus/main/LICENSE"
   },
   "n": 3
  },
  {
   "key": "agent_access",
   "label": "Agent access",
   "value": "npm package",
   "status": "info",
   "sub": "Installs without a key",
   "quote": null,
   "note": "An agent can install it by itself with npm install create-docusaurus. No key or account is needed.",
   "source": {
    "label": "github.com/meta/docusaurus",
    "url": "https://github.com/meta/docusaurus"
   },
   "n": 4
  }
 ],
 "license": {
  "name": "MIT",
  "url": "https://raw.githubusercontent.com/facebook/docusaurus/main/LICENSE",
  "summary": "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.",
  "pages_read": 1,
  "rules": [
   "Keep the MIT copyright notice in the code if you redistribute it.",
   "No visible credit on the site is required by the licence."
  ],
  "rows": [
   {
    "label": "Commercial use",
    "value": "Yes",
    "status": "yes",
    "quote": "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",
    "source": {
     "label": "raw.githubusercontent.com",
     "url": "https://raw.githubusercontent.com/facebook/docusaurus/main/LICENSE"
    },
    "note": null
   },
   {
    "label": "Credit",
    "value": "Not needed",
    "status": "yes",
    "quote": "The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.",
    "source": {
     "label": "raw.githubusercontent.com",
     "url": "https://raw.githubusercontent.com/facebook/docusaurus/main/LICENSE"
    },
    "note": null
   },
   {
    "label": "Inside your app or game",
    "value": "Can ship inside your app",
    "status": "yes",
    "quote": "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",
    "source": {
     "label": "raw.githubusercontent.com",
     "url": "https://raw.githubusercontent.com/facebook/docusaurus/main/LICENSE"
    },
    "note": null
   },
   {
    "label": "Pass the files on to your users",
    "value": "Allowed",
    "status": "yes",
    "quote": "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",
    "source": {
     "label": "raw.githubusercontent.com",
     "url": "https://raw.githubusercontent.com/facebook/docusaurus/main/LICENSE"
    },
    "note": null
   },
   {
    "label": "AI training",
    "value": "Not stated",
    "status": "unknown",
    "quote": null,
    "source": null,
    "note": null
   },
   {
    "label": "Bots and bulk downloads",
    "value": "Not stated",
    "status": "unknown",
    "quote": null,
    "source": null,
    "note": null
   }
  ],
  "checked_at": "2026-11-05",
  "commercial_use_page": "https://agentgid.com/assets/docusaurus/commercial-use/"
 },
 "overview": {
  "heading": "Docusaurus: a docs website built from text files",
  "body": "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."
 },
 "uses": [
  {
   "title": "Docs site for your product",
   "text": "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.",
   "idea": false,
   "image": null
  },
  {
   "title": "A blog next to the docs",
   "text": "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.",
   "idea": false,
   "image": null
  },
  {
   "title": "The same docs in several languages",
   "text": "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.",
   "idea": false,
   "image": null
  },
  {
   "title": "Docs for each release",
   "text": "Keep the docs for version 1.0 readable while you write the docs for 2.0. Readers pick their version from a menu.",
   "idea": false,
   "image": null
  },
  {
   "title": "Landing page or personal site",
   "text": "Use the same tool for a product landing page, a personal site or a blog that has no docs at all.",
   "idea": false,
   "image": null
  },
  {
   "title": "Help center for your app users",
   "text": "Write help articles for customers, such as how to change a plan or export data, and link to them from inside your app.",
   "idea": true,
   "image": null
  }
 ],
 "start": {
  "prompt": "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.",
  "install": "npx create-docusaurus@latest my-website classic",
  "install_note": "With Node.js 20 or newer installed, create a site from the classic template (docs, blog, pages and dark mode).",
  "code": [
   {
    "tab": "Step 1",
    "intro": "Start the preview server; pages update as you edit the files.",
    "source": "cd my-website\nnpm run start"
   },
   {
    "tab": "Step 2",
    "intro": "Build the site; the build folder holds plain web files you can upload to any static hosting.",
    "source": "npm run build"
   }
  ]
 },
 "mistakes": [
  {
   "dont": "Updating only @docusaurus/core (for example to 3.10.2) and leaving @docusaurus/preset-classic on an older version",
   "fix": "Set every @docusaurus/* package in package.json to the same exact version, then run npm install",
   "why": "The packages are released together and are meant to match.",
   "dont_code": false,
   "fix_code": false
  },
  {
   "dont": "url: 'https://my-org.com/my-project' with baseUrl: '/'",
   "fix": "url: 'https://my-org.com/' and baseUrl: '/my-project/' (with the trailing slash)",
   "why": "Links and files load from the wrong place when the site lives in a subfolder.",
   "dont_code": false,
   "fix_code": false
  },
  {
   "dont": "Reading process.env.MY_VALUE inside a React page or MDX file",
   "fix": "Read the variable in docusaurus.config.js, put it in customFields and read it with useDocusaurusContext()",
   "why": "Only the config file runs in Node.js; pages run in the browser and have no process variable.",
   "dont_code": false,
   "fix_code": false
  },
  {
   "dont": "Writing the HTML comment truncate marker in a .mdx blog post",
   "fix": "In .mdx files use the MDX comment form {/* truncate */}; the HTML comment form is for .md files",
   "why": "MDX files use a different comment syntax, so the summary cut does not work.",
   "dont_code": false,
   "fix_code": false
  },
  {
   "dont": "Turning on docs versioning for a small project from day one",
   "fix": "Add versions only when the docs change a lot between releases",
   "why": "Versioning makes builds slower and editing harder.",
   "dont_code": false,
   "fix_code": false
  }
 ],
 "agent": {
  "self_serve": true,
  "self_serve_text": "Agent installs a package or loads it from a CDN",
  "install": "npm install create-docusaurus",
  "repo": "https://github.com/meta/docusaurus",
  "api_docs": null,
  "api_account": "Not needed. Everything runs on your side.",
  "get_files": "npm init docusaurus@latest (pick the classic template); no account.",
  "formats": [
   "mdx",
   "jsx",
   "css"
  ],
  "limits": null,
  "mcp": null,
  "mcp_url": null,
  "credit_line": "Built with Docusaurus.",
  "rules_text": "- 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.\n  Connect: npm create-docusaurus.\n  Get files: npm init docusaurus@latest (pick the classic template); no account (mdx, jsx, css).\n  Not allowed: Needs Node.js\n  Rule: Keep the MIT copyright notice in the code if you redistribute it.\n  Rule: No visible credit on the site is required by the licence.\n  License: https://raw.githubusercontent.com/facebook/docusaurus/main/LICENSE (checked 2026-11-05; details: https://agentgid.com/assets/docusaurus/)",
  "agent_md": "https://agentgid.com/assets/docusaurus/agent.md",
  "card_json": "https://agentgid.com/assets/docusaurus/card.json"
 },
 "popularity": {
  "gid_score": 34,
  "stars": 66749,
  "downloads_7d": 6699,
  "downloads_7d_label": "6,699",
  "downloads_change_4w_pct": -36.5,
  "eco": "npm",
  "package": "create-docusaurus",
  "repo": "meta/docusaurus",
  "agent_projects": null,
  "agent_projects_total": null,
  "downloads_unconfirmed": false,
  "series": {
   "downloads_weekly": [
    [
     "2025-11-17",
     6622
    ],
    [
     "2025-11-24",
     6379
    ],
    [
     "2025-12-01",
     8742
    ],
    [
     "2025-12-08",
     5678
    ],
    [
     "2025-12-15",
     5689
    ],
    [
     "2025-12-22",
     3301
    ],
    [
     "2025-12-29",
     2750
    ],
    [
     "2026-01-05",
     5425
    ],
    [
     "2026-01-12",
     5215
    ],
    [
     "2026-01-19",
     5497
    ],
    [
     "2026-01-26",
     6406
    ],
    [
     "2026-02-02",
     8021
    ],
    [
     "2026-02-09",
     6469
    ],
    [
     "2026-02-16",
     7016
    ],
    [
     "2026-02-23",
     6715
    ],
    [
     "2026-03-02",
     8531
    ],
    [
     "2026-03-09",
     11611
    ],
    [
     "2026-03-16",
     18580
    ],
    [
     "2026-03-23",
     11438
    ],
    [
     "2026-03-30",
     8093
    ],
    [
     "2026-04-06",
     8323
    ],
    [
     "2026-04-13",
     9396
    ],
    [
     "2026-04-20",
     5153
    ],
    [
     "2026-04-27",
     7592
    ],
    [
     "2026-05-04",
     6445
    ],
    [
     "2026-05-11",
     8790
    ],
    [
     "2026-05-18",
     7528
    ],
    [
     "2026-05-25",
     6551
    ],
    [
     "2026-06-01",
     9852
    ],
    [
     "2026-06-08",
     4730
    ],
    [
     "2026-06-15",
     6523
    ],
    [
     "2026-06-22",
     4253
    ],
    [
     "2026-06-29",
     5737
    ],
    [
     "2026-07-06",
     5558
    ],
    [
     "2026-07-13",
     5219
    ],
    [
     "2026-07-20",
     7809
    ],
    [
     "2026-07-27",
     3853
    ],
    [
     "2026-08-03",
     5575
    ],
    [
     "2026-08-10",
     5109
    ],
    [
     "2026-08-17",
     3559
    ],
    [
     "2026-08-24",
     5132
    ],
    [
     "2026-08-31",
     5984
    ],
    [
     "2026-09-07",
     6142
    ],
    [
     "2026-09-14",
     8774
    ],
    [
     "2026-09-21",
     7909
    ],
    [
     "2026-09-28",
     9878
    ],
    [
     "2026-10-05",
     9920
    ],
    [
     "2026-10-12",
     10671
    ],
    [
     "2026-10-19",
     5529
    ],
    [
     "2026-10-26",
     5384
    ],
    [
     "2026-11-02",
     6758
    ],
    [
     "2026-11-09",
     6699
    ]
   ],
   "stars": [
    [
     "2026-11-07",
     66671
    ],
    [
     "2026-11-08",
     66670
    ],
    [
     "2026-11-09",
     66681
    ],
    [
     "2026-11-10",
     66695
    ],
    [
     "2026-11-11",
     66706
    ],
    [
     "2026-11-12",
     66715
    ],
    [
     "2026-11-13",
     66725
    ],
    [
     "2026-11-14",
     66733
    ],
    [
     "2026-11-15",
     66741
    ],
    [
     "2026-11-16",
     66745
    ],
    [
     "2026-11-17",
     66749
    ]
   ]
  },
  "stars_flat_since": null,
  "updated_at": "2026-11-17"
 },
 "alternatives": [
  {
   "slug": "docusaurus",
   "name": "Docusaurus",
   "why": null,
   "current": true,
   "price": "Free",
   "commercial": {
    "value": "Commercial OK",
    "status": "yes"
   },
   "access": "npm"
  },
  {
   "slug": "vitepress",
   "name": "VitePress",
   "why": "Pick VitePress when your project uses Vue instead of React; the Docusaurus docs name it the Vue choice.",
   "current": false,
   "price": "Free",
   "commercial": {
    "value": "Commercial OK",
    "status": "yes"
   },
   "access": "npm"
  },
  {
   "slug": "starlight",
   "name": "Starlight",
   "why": "Pick Starlight for an Astro docs site with navigation, search, translations and dark mode ready out of the box.",
   "current": false,
   "price": "Free",
   "commercial": {
    "value": "Commercial OK",
    "status": "yes"
   },
   "access": "npm"
  },
  {
   "slug": "nextra",
   "name": "Nextra",
   "why": "Pick Nextra when your app already runs on Next.js and you want the docs in the same stack.",
   "current": false,
   "price": "Free",
   "commercial": {
    "value": "Commercial OK",
    "status": "yes"
   },
   "access": "npm"
  },
  {
   "slug": "bootstrap-examples",
   "name": "Bootstrap Examples",
   "why": "Official Bootstrap 5 example snippets and layouts: heroes, features, pricing, headers, footers, dashboards; one zip download.",
   "current": false,
   "price": "Free",
   "commercial": {
    "value": "Commercial OK",
    "status": "yes"
   },
   "access": "npm"
  },
  {
   "slug": "nuxt-ui",
   "name": "Nuxt UI",
   "why": "Vue/Nuxt UI library (125+ components, Reka UI + Tailwind) with page-level components and MIT starter templates: landing, SaaS, docs, dashboard.",
   "current": false,
   "price": "Free",
   "commercial": {
    "value": "Commercial OK",
    "status": "yes"
   },
   "access": "npm"
  }
 ],
 "faq": [
  {
   "q": "Do I need to know React to use it?",
   "a": "No. You write docs and blog posts as Markdown files; React is only needed to build custom pages or change the layout."
  },
  {
   "q": "Can I use it for a paid product or a client site?",
   "a": "Yes. The MIT license allows use, change and sale; keep the license notice with copies of its code."
  },
  {
   "q": "Does the finished site need a server with Node.js?",
   "a": "No. The build is a folder of static files, and the site generally works even without JavaScript."
  },
  {
   "q": "Can I try it without installing anything?",
   "a": "Yes. The docs point to docusaurus.new, a playground that runs in the browser."
  },
  {
   "q": "Is it only for docs?",
   "a": "No. It can make any kind of site, such as a personal site, a blog or a landing page."
  }
 ],
 "at_a_glance": {
  "latest_version": "3.10.2",
  "last_release": "2026-07-10",
  "last_commit": "2026-11-15",
  "runtime": "Node.js 20.0+ to build; React 18 or 19 (peer: react ^18.0.0 || ^19.0.0, @mdx-js/react ^3.0.0). All @docusaurus/* packages on the same version.",
  "key_needed": false,
  "formats": "mdx, jsx, css"
 },
 "good_to_know": [
  "Building the site needs Node.js 20 or newer on your computer or build server. Visitors only get plain web pages.",
  "Docusaurus only builds the files; where you host them is your choice, for example GitHub Pages, Netlify or Vercel.",
  "The official search uses Algolia DocSearch. It is free for developer docs, but you have to apply for it first.",
  "Docs for each release make builds slower and the project harder to edit. The docs advise skipping them when the docs rarely change.",
  "Each language is built as a separate site, so the preview shows one language at a time."
 ],
 "stack_snippets": [],
 "claims": [],
 "checked": {
  "license_read": "2026-11-05",
  "overview_checked": "2026-11-09",
  "numbers_updated": "2026-11-17",
  "sources": [
   {
    "label": "docusaurus.io",
    "url": "https://docusaurus.io/"
   },
   {
    "label": "docusaurus.io/docs",
    "url": "https://docusaurus.io/docs"
   },
   {
    "label": "docusaurus.io/docs/installation",
    "url": "https://docusaurus.io/docs/installation"
   },
   {
    "label": "docusaurus.io/docs/blog",
    "url": "https://docusaurus.io/docs/blog"
   },
   {
    "label": "docusaurus.io/docs/i18n/introduction",
    "url": "https://docusaurus.io/docs/i18n/introduction"
   },
   {
    "label": "docusaurus.io/docs/i18n/tutorial",
    "url": "https://docusaurus.io/docs/i18n/tutorial"
   },
   {
    "label": "docusaurus.io/docs/versioning",
    "url": "https://docusaurus.io/docs/versioning"
   },
   {
    "label": "docusaurus.io/docs/search",
    "url": "https://docusaurus.io/docs/search"
   },
   {
    "label": "docusaurus.io/docs/deployment",
    "url": "https://docusaurus.io/docs/deployment"
   },
   {
    "label": "docusaurus.io/docs/creating-pages",
    "url": "https://docusaurus.io/docs/creating-pages"
   },
   {
    "label": "docusaurus.io/docs/seo",
    "url": "https://docusaurus.io/docs/seo"
   },
   {
    "label": "README on GitHub",
    "url": "https://github.com/facebook/docusaurus/blob/main/README.md"
   },
   {
    "label": "LICENSE on GitHub",
    "url": "https://github.com/facebook/docusaurus/blob/main/LICENSE"
   },
   {
    "label": "npm: @docusaurus/core/latest",
    "url": "https://registry.npmjs.org/@docusaurus/core/latest"
   },
   {
    "label": "npm: create-docusaurus/latest",
    "url": "https://registry.npmjs.org/create-docusaurus/latest"
   },
   {
    "label": "docusaurus.io",
    "url": "https://docusaurus.io"
   },
   {
    "label": "github.com/facebook/docusaurus",
    "url": "https://github.com/facebook/docusaurus"
   },
   {
    "label": "raw.githubusercontent.com",
    "url": "https://raw.githubusercontent.com/facebook/docusaurus/main/LICENSE"
   }
  ],
  "unverified": null
 },
 "user_reports": null,
 "url": "https://agentgid.com/assets/docusaurus/",
 "note": "Written by AgentGid from the official pages in checked.sources; quotes are copied from those pages. status: yes | cond | no | unknown | info. Prices and vendor claims are as reported on the checked date. Not legal advice."
}
