{
 "slug": "fumadocs",
 "name": "Fumadocs",
 "author": "Fuma",
 "density": "full",
 "status": "active",
 "status_note": null,
 "alternatives_page": null,
 "one_liner": "Next.js / React Router docs framework with ready templates (docs layout, search, OpenAPI pages).",
 "category": {
  "slug": "page-templates",
  "name": "Page and site templates"
 },
 "tags": [
  "Code library",
  "Open source"
 ],
 "styles": [
  "minimal"
 ],
 "logo_url": "https://agentgid.com/media/avatars/fuma-nama.png",
 "logo_letter": "F",
 "links": {
  "repo": "https://github.com/fuma-nama/fumadocs",
  "website": "https://fumadocs.dev",
  "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": "fumadocs.dev",
    "url": "https://fumadocs.dev"
   },
   "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 in paid products.",
   "source": {
    "label": "raw.githubusercontent.com",
    "url": "https://raw.githubusercontent.com/fuma-nama/fumadocs/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/fuma-nama/fumadocs/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-fumadocs-app. No key or account is needed.",
   "source": {
    "label": "github.com/fuma-nama/fumadocs",
    "url": "https://github.com/fuma-nama/fumadocs"
   },
   "n": 4
  }
 ],
 "license": {
  "name": "MIT",
  "url": "https://raw.githubusercontent.com/fuma-nama/fumadocs/main/LICENSE",
  "summary": "Free to use in personal and paid products, and you may change and share the code. Keep the copyright and license notice with copies of the code; no visible credit on the site is required.",
  "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/fuma-nama/fumadocs/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/fuma-nama/fumadocs/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/fuma-nama/fumadocs/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/fuma-nama/fumadocs/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/fumadocs/commercial-use/"
 },
 "overview": {
  "heading": "Fumadocs: a docs website inside your React app",
  "body": "Fumadocs is a free kit for building a documentation website inside a React app, such as one made with Next.js or Astro. You write pages as Markdown files and get a ready docs layout with a sidebar, search and light and dark themes. It can also turn an OpenAPI file into API reference pages and serve your docs as plain text for AI assistants."
 },
 "uses": [
  {
   "title": "Help pages for your product",
   "text": "Start a docs site for your app or library and write each page as a Markdown file. The sidebar, search and theme come ready.",
   "idea": false,
   "image": null
  },
  {
   "title": "Reference pages for your API",
   "text": "If your backend has an OpenAPI file, Fumadocs makes one reference page per request type from it, so the pages stay in step with the code.",
   "idea": false,
   "image": null
  },
  {
   "title": "Docs that AI assistants can read",
   "text": "Publish your docs as plain Markdown at /llms.txt and /llms-full.txt, so AI coding assistants can read the whole manual in one go.",
   "idea": false,
   "image": null
  },
  {
   "title": "Docs on plain static hosting",
   "text": "Build the whole docs site as ready HTML files and put it on any static host, with search running in the reader's browser.",
   "idea": false,
   "image": null
  },
  {
   "title": "A blog next to the docs",
   "text": "Add a blog with posts, tags and authors to the same site, written as Markdown files like the docs.",
   "idea": false,
   "image": null
  },
  {
   "title": "Docs in several languages",
   "text": "Offer the same docs in more than one language, with the sidebar and pages switching by language.",
   "idea": false,
   "image": null
  }
 ],
 "start": {
  "prompt": "Create a Fumadocs docs site with create-fumadocs-app 16.3.1 on Node 22+, using Next.js and Fumadocs MDX, add a Getting started page in content/docs, and turn on static export so it can be hosted as plain HTML files.",
  "install": "npm create fumadocs-app",
  "install_note": "With Node.js 22 or newer, create a new docs app and pick the framework and content source when asked.",
  "code": [
   {
    "tab": "Step 1",
    "intro": "Write your first page as an MDX file in the docs folder.",
    "source": "---\ntitle: Hello World\n---\n\n## Yo what's up"
   },
   {
    "tab": "Step 2",
    "intro": "Run the app and open the docs page in the browser.",
    "source": "npm run dev"
   }
  ]
 },
 "mistakes": [
  {
   "dont": "Running create-fumadocs-app or a build on Node 18 or 20",
   "fix": "Use Node.js 22.18+ (or 24.11+)",
   "why": "The packages need Node 22; older Node gives Turbopack \"JSON file not found\" errors because require(esm) is missing.",
   "dont_code": false,
   "fix_code": false
  },
  {
   "dont": "const { loader } = require('fumadocs-core/source')",
   "fix": "import { loader } from 'fumadocs-core/source'",
   "why": "All Fumadocs packages are ESM only.",
   "dont_code": true,
   "fix_code": true
  },
  {
   "dont": "Adding OpenAPI pages to the loader and leaving the docs page and llms routes unchanged",
   "fix": "Check page.type === 'openapi' everywhere source is used and render those pages with <OpenAPIPage />",
   "why": "After the change, source holds two page types and the old code breaks on OpenAPI pages.",
   "dont_code": false,
   "fix_code": false
  },
  {
   "dont": "Calling docsLlms.page() or docsLlms.full() after llms(source) with no options",
   "fix": "Pass renderPage to llms() and turn on includeProcessedMarkdown in source.config.ts",
   "why": "Without renderPage only the index works.",
   "dont_code": false,
   "fix_code": false
  },
  {
   "dont": "Setting output 'export' and keeping the default search server route as is",
   "fix": "Configure the search server and client for static mode so the index is stored as files",
   "why": "The default setup is server-first and needs a running server.",
   "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-fumadocs-app",
  "repo": "https://github.com/fuma-nama/fumadocs",
  "api_docs": null,
  "api_account": "Not needed. Everything runs on your side.",
  "get_files": "npm create fumadocs-app; no account.",
  "formats": [
   "mdx",
   "tsx"
  ],
  "limits": null,
  "mcp": null,
  "mcp_url": null,
  "credit_line": "Docs built with Fumadocs (MIT)",
  "rules_text": "- Fumadocs (Page and site templates). Next.js / React Router docs framework with ready templates (docs layout, search, OpenAPI pages). Price: free; commercial use OK; no credit needed. Style: minimal.\n  Connect: npm create-fumadocs-app.\n  Get files: npm create fumadocs-app; no account (mdx, tsx).\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/fuma-nama/fumadocs/main/LICENSE (checked 2026-11-05; details: https://agentgid.com/assets/fumadocs/)",
  "agent_md": "https://agentgid.com/assets/fumadocs/agent.md",
  "card_json": "https://agentgid.com/assets/fumadocs/card.json"
 },
 "popularity": {
  "gid_score": 27,
  "stars": 13648,
  "downloads_7d": 2867,
  "downloads_7d_label": "2,867",
  "downloads_change_4w_pct": -11.6,
  "eco": "npm",
  "package": "create-fumadocs-app",
  "repo": "fuma-nama/fumadocs",
  "agent_projects": null,
  "agent_projects_total": null,
  "downloads_unconfirmed": false,
  "series": {
   "downloads_weekly": [
    [
     "2025-11-17",
     1596
    ],
    [
     "2025-11-24",
     896
    ],
    [
     "2025-12-01",
     942
    ],
    [
     "2025-12-08",
     1210
    ],
    [
     "2025-12-15",
     1342
    ],
    [
     "2025-12-22",
     846
    ],
    [
     "2025-12-29",
     1243
    ],
    [
     "2026-01-05",
     1177
    ],
    [
     "2026-01-12",
     1407
    ],
    [
     "2026-01-19",
     971
    ],
    [
     "2026-01-26",
     1173
    ],
    [
     "2026-02-02",
     1094
    ],
    [
     "2026-02-09",
     1553
    ],
    [
     "2026-02-16",
     1232
    ],
    [
     "2026-02-23",
     1320
    ],
    [
     "2026-03-02",
     1513
    ],
    [
     "2026-03-09",
     1717
    ],
    [
     "2026-03-16",
     1423
    ],
    [
     "2026-03-23",
     1486
    ],
    [
     "2026-03-30",
     1239
    ],
    [
     "2026-04-06",
     1271
    ],
    [
     "2026-04-13",
     1639
    ],
    [
     "2026-04-20",
     1576
    ],
    [
     "2026-04-27",
     1240
    ],
    [
     "2026-05-04",
     1525
    ],
    [
     "2026-05-11",
     2492
    ],
    [
     "2026-05-18",
     1792
    ],
    [
     "2026-05-25",
     1790
    ],
    [
     "2026-06-01",
     1541
    ],
    [
     "2026-06-08",
     1461
    ],
    [
     "2026-06-15",
     1693
    ],
    [
     "2026-06-22",
     1450
    ],
    [
     "2026-06-29",
     1989
    ],
    [
     "2026-07-06",
     1797
    ],
    [
     "2026-07-13",
     1268
    ],
    [
     "2026-07-20",
     2352
    ],
    [
     "2026-07-27",
     1475
    ],
    [
     "2026-08-03",
     1906
    ],
    [
     "2026-08-10",
     1799
    ],
    [
     "2026-08-17",
     1771
    ],
    [
     "2026-08-24",
     1577
    ],
    [
     "2026-08-31",
     2510
    ],
    [
     "2026-09-07",
     1383
    ],
    [
     "2026-09-14",
     1312
    ],
    [
     "2026-09-21",
     2049
    ],
    [
     "2026-09-28",
     2820
    ],
    [
     "2026-10-05",
     2073
    ],
    [
     "2026-10-12",
     1790
    ],
    [
     "2026-10-19",
     1084
    ],
    [
     "2026-10-26",
     1557
    ],
    [
     "2026-11-02",
     2207
    ],
    [
     "2026-11-09",
     2867
    ]
   ],
   "stars": [
    [
     "2026-11-07",
     13568
    ],
    [
     "2026-11-08",
     13573
    ],
    [
     "2026-11-09",
     13575
    ],
    [
     "2026-11-10",
     13586
    ],
    [
     "2026-11-11",
     13591
    ],
    [
     "2026-11-12",
     13597
    ],
    [
     "2026-11-13",
     13606
    ],
    [
     "2026-11-14",
     13616
    ],
    [
     "2026-11-15",
     13626
    ],
    [
     "2026-11-16",
     13635
    ],
    [
     "2026-11-17",
     13648
    ]
   ]
  },
  "stars_flat_since": null,
  "updated_at": "2026-11-17"
 },
 "alternatives": [
  {
   "slug": "fumadocs",
   "name": "Fumadocs",
   "why": null,
   "current": true,
   "price": "Free",
   "commercial": {
    "value": "Commercial OK",
    "status": "yes"
   },
   "access": "npm"
  },
  {
   "slug": "docusaurus",
   "name": "Docusaurus",
   "why": "Pick Docusaurus for a simple React docs site with a ready docs, blog and landing template and many plugins.",
   "current": false,
   "price": "Free",
   "commercial": {
    "value": "Commercial OK",
    "status": "yes"
   },
   "access": "npm"
  },
  {
   "slug": "nextra",
   "name": "Nextra",
   "why": "Pick Nextra for a Next.js docs site or blog with a ready docs theme and a starter template.",
   "current": false,
   "price": "Free",
   "commercial": {
    "value": "Commercial OK",
    "status": "yes"
   },
   "access": "npm"
  },
  {
   "slug": "starlight",
   "name": "Starlight",
   "why": "Pick Starlight when your site runs on Astro and you want navigation, search, i18n and dark mode out of the box.",
   "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": "vitepress",
   "name": "VitePress",
   "why": "Vite + Vue static site generator with a default docs theme and a home/landing layout.",
   "current": false,
   "price": "Free",
   "commercial": {
    "value": "Commercial OK",
    "status": "yes"
   },
   "access": "npm"
  }
 ],
 "faq": [
  {
   "q": "Which frameworks does it work with?",
   "a": "Next.js, React Router, TanStack Start, Waku and Astro with React. Next.js is the makers' choice for new projects."
  },
  {
   "q": "Can I host it without a server?",
   "a": "Yes. Turn on static export in Next.js and set up static search; the site is then plain HTML files and search runs in the browser."
  },
  {
   "q": "Can I add it to an app I already have?",
   "a": "Yes. The docs have a manual installation guide for adding Fumadocs to an existing Next.js project."
  },
  {
   "q": "Is it free for a paid product?",
   "a": "Yes. It is MIT licensed; keep the license notice with the code. No credit on the site is required."
  }
 ],
 "at_a_glance": {
  "latest_version": "16.3.1",
  "last_release": "2026-11-17",
  "last_commit": "2026-11-17",
  "runtime": "Node.js ^22.18.0 or >=24.11.0. The fumadocs-ui 16.19.0 theme for Next.js needs Next 16 and React 19.2+.",
  "key_needed": false,
  "formats": "mdx, tsx"
 },
 "good_to_know": [
  "It needs Node.js 22 or newer. On older versions the build can fail with errors about missing files.",
  "You need some React knowledge to change how pages look. The makers say a simple docs site may be easier with Docusaurus.",
  "By default the site needs a running server. For plain file hosting you turn on static export and set search up for it.",
  "All its packages use the modern import style only, so old require() code cannot load them.",
  "There are fewer ready plugins than for Docusaurus, so some features you build yourself."
 ],
 "stack_snippets": [],
 "claims": [
  "Fumadocs lists OpenAPI integration as a feature it has and Nextra does not"
 ],
 "checked": {
  "license_read": "2026-11-05",
  "overview_checked": "2026-11-12",
  "numbers_updated": "2026-11-17",
  "sources": [
   {
    "label": "fumadocs.dev",
    "url": "https://fumadocs.dev"
   },
   {
    "label": "fumadocs.dev/docs",
    "url": "https://fumadocs.dev/docs"
   },
   {
    "label": "fumadocs.dev/docs.mdx",
    "url": "https://fumadocs.dev/docs.mdx"
   },
   {
    "label": "fumadocs.dev/llms.txt",
    "url": "https://fumadocs.dev/llms.txt"
   },
   {
    "label": "fumadocs.dev/docs/next.mdx",
    "url": "https://fumadocs.dev/docs/next.mdx"
   },
   {
    "label": "fumadocs.dev",
    "url": "https://fumadocs.dev/docs/next/what-is-fumadocs.mdx"
   },
   {
    "label": "fumadocs.dev/docs/next/comparisons.mdx",
    "url": "https://fumadocs.dev/docs/next/comparisons.mdx"
   },
   {
    "label": "fumadocs.dev",
    "url": "https://fumadocs.dev/docs/next/deploying/static.mdx"
   },
   {
    "label": "fumadocs.dev/docs/next/search.mdx",
    "url": "https://fumadocs.dev/docs/next/search.mdx"
   },
   {
    "label": "fumadocs.dev",
    "url": "https://fumadocs.dev/docs/next/integrations/openapi.mdx"
   },
   {
    "label": "fumadocs.dev",
    "url": "https://fumadocs.dev/docs/next/integrations/llms.mdx"
   },
   {
    "label": "fumadocs.dev",
    "url": "https://fumadocs.dev/docs/next/integrations/blog.mdx"
   },
   {
    "label": "fumadocs.dev",
    "url": "https://fumadocs.dev/docs/next/internationalization.mdx"
   },
   {
    "label": "github.com/fuma-nama/fumadocs",
    "url": "https://github.com/fuma-nama/fumadocs"
   },
   {
    "label": "README on GitHub",
    "url": "https://github.com/fuma-nama/fumadocs/blob/HEAD/README.md"
   },
   {
    "label": "raw.githubusercontent.com",
    "url": "https://raw.githubusercontent.com/fuma-nama/fumadocs/main/LICENSE"
   },
   {
    "label": "npm: create-fumadocs-app/latest",
    "url": "https://registry.npmjs.org/create-fumadocs-app/latest"
   },
   {
    "label": "npm: fumadocs-ui/latest",
    "url": "https://registry.npmjs.org/fumadocs-ui/latest"
   }
  ],
  "unverified": null
 },
 "user_reports": null,
 "url": "https://agentgid.com/assets/fumadocs/",
 "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."
}
