What is this?
Fumadocs is a framework for building documentation websites in React.js frameworks and Astro, with built-in search, theming, and MDX content handling.
Fumadocs is a framework for building documentation websites in React.js frameworks and Astro, with built-in search, theming, and MDX content handling.Is it a framework or a set of plug-and-play components?It is a documentation framework, not a standalone app: you add it on top of Next.js, Astro, or a Vite-based React setup like Tanstack Start, Waku, or React Router to generate your docs site.
It is a documentation framework, not a standalone app: you add it on top of Next.js, Astro, or a Vite-based React setup like Tanstack Start, Waku, or React Router to generate your docs site.How do I add it to a project?You add Fumadocs into one of the officially supported React setups (Next.js, Astro with React, or Vite-based frameworks) and write your content in MDX. Full setup steps are in the official documentation.
You add Fumadocs into one of the officially supported React setups (Next.js, Astro with React, or Vite-based frameworks) and write your content in MDX. Full setup steps are in the official documentation.Do I need Next.js specifically, or can I use something else?No, Next.js is just one option; Astro (with React) and Vite-based frameworks like Tanstack Start, Waku, and React Router are also officially supported.
No, Next.js is just one option; Astro (with React) and Vite-based frameworks like Tanstack Start, Waku, and React Router are also officially supported.Any install pitfalls I should know about?All Fumadocs packages are ESM only, so you need a module setup that supports ESM imports rather than CommonJS.
All Fumadocs packages are ESM only, so you need a module setup that supports ESM imports rather than CommonJS.Does Fumadocs support Tailwind CSS styling out of the box?Yes, Tailwind CSS integration is listed among its supported tooling alongside MDX content handling.
Yes, Tailwind CSS integration is listed among its supported tooling alongside MDX content handling.What content sources can I use with Fumadocs?It works with MDX, content-collections, and Contentlayer for managing documentation content.
It works with MDX, content-collections, and Contentlayer for managing documentation content.Is there a visual way to show off that I use Fumadocs?The project offers a printable sticker for fans to show their support.
The project offers a printable sticker for fans to show their support.What are similar projects?docz, nextra, docusaurus, cheatsheets, docs, NotionNext, gitbook, nuvex-docs
docz, nextra, docusaurus, cheatsheets, docs, NotionNext, gitbook, nuvex-docsWhich topics is it in?tanstack-router, react-router, docs, documentation-tool, astro, mdx, static-site-generator, tailwindcss, nextjs, documentation, markdown, web-development
tanstack-router, react-router, docs, documentation-tool, astro, mdx, static-site-generator, tailwindcss, nextjs, documentation, markdown, web-development