SPB Git
4.2 KB · 49 lines json
1{2  "slug": "docusaurus",3  "name": "Docusaurus",4  "aliases": [],5  "vendor": { "name": "Meta Open Source", "slug": "meta", "website": "https://opensource.fb.com" },6  "homepage_url": "https://docusaurus.io/",7  "docs_url": "https://docusaurus.io/docs",8  "repo_url": "https://github.com/meta/docusaurus",9  "license_url": "https://github.com/meta/docusaurus/blob/main/LICENSE",10  "product_type": "framework",11  "product_status": "active",12  "summary": "React-based static site generator from Meta for documentation sites with MDX content, versioning, localization and a plugin architecture",13  "description": "Docusaurus is a static site generator maintained by Meta Open Source and released under the MIT license. It is built on React and renders documentation written in Markdown or MDX, which allows React components to be embedded in pages. The default preset includes a documentation section with sidebars, a blog, a landing page, client-side search integration, dark mode and a theme that can be swizzled (overridden component by component).\n\nTwo features distinguish it from Markdown-only generators: documentation versioning, which snapshots the docs for each release, and internationalization, which produces one site per locale from translated files. Docusaurus is widely used for open-source project sites and developer portals, and deploys as static files to GitHub Pages, Vercel, Netlify or any web server. The trade-offs are those of a JavaScript framework: it requires Node.js and a build step, build times grow with large sites, and customizing beyond the theme means writing React. It is not a fit for projects that want to avoid a JavaScript toolchain.",14  "capabilities": ["Markdown and MDX content with embedded React components", "Documentation versioning", "Internationalization with per-locale builds", "Blog, sidebars and landing pages in one preset", "Swizzlable theme and plugin architecture", "Static output for any host"],15  "workflows": ["Publish a versioned developer portal for a library", "Translate documentation into several languages", "Embed interactive React demos inside docs pages"],16  "advantages": ["Versioning and localization built in", "React ecosystem for customization", "MIT license"],17  "limitations": ["Requires Node.js and a build toolchain", "Build times increase with large sites", "Customization beyond theming requires React"],18  "prerequisites": ["Node.js and a package manager"],19  "audiences": ["Open-source maintainers", "Developer relations and documentation teams"],20  "alternatives": ["mkdocs", "sphinx", "nextjs"],21  "comparison_notes": "MkDocs and Sphinx are Python generators with lighter toolchains and strong API-reference support; Docusaurus wins on interactive content, versioning and localization. Next.js is a general web framework that can host documentation but requires building the documentation features yourself.",22  "categories": [{ "slug": "documentation", "primary": true }],23  "tags": ["documentation", "react", "markdown", "open-source", "static-site", "typescript"],24  "use_cases": [],25  "operating_systems": ["macos", "linux", "windows"],26  "execution_modes": ["local", "cloud"],27  "interfaces": ["cli", "library"],28  "deployment_models": ["desktop"],29  "integrations": ["React", "MDX", "Algolia DocSearch", "GitHub Pages", "Vercel", "Netlify"],30  "data_formats": ["Markdown", "MDX", "JSON", "HTML"],31  "languages": ["TypeScript", "JavaScript"],32  "source_model": "open-source",33  "license_spdx": "MIT",34  "pricing_model": ["open-source", "free"],35  "self_hostable": true,36  "sources": [37    { "url": "https://docusaurus.io/", "type": "official_site", "title": "Docusaurus", "supports": ["name", "summary"], "checked_at": "2026-11-02" },38    { "url": "https://docusaurus.io/docs", "type": "official_docs", "title": "Docusaurus documentation", "supports": ["capabilities"], "checked_at": "2026-11-02" },39    { "url": "https://github.com/meta/docusaurus/blob/main/LICENSE", "type": "license_page", "supports": ["license_spdx", "source_model"], "checked_at": "2026-11-02", "note": "Repository moved from facebook/docusaurus to meta/docusaurus" }40  ],41  "confidence": "high",42  "discovery_method": "editorial-research",43  "depth": "standard",44  "editorial_status": "reviewed",45  "visibility": "public",46  "featured": false,47  "author": "batch-B1"48}49
Files · 19c0ff748ee94e0979c734f5fb3afeefc11ee9e1
Menu

Theme