DEV Community

Alex Spinov
Alex Spinov

Posted on

Fumadocs Has a Free API That Most Developers Dont Know About

#nextjs #documentation #mdx #webdev

Fumadocs is a documentation framework for Next.js. It provides MDX support, full-text search, OpenAPI integration, and beautiful defaults.

Quick Start 

npx create-fumadocs-app
cd my-docs
npm run dev
Enter fullscreen mode Exit fullscreen mode

File Structure 

content/docs/
  index.mdx          # /docs
  getting-started.mdx # /docs/getting-started
  api/
    index.mdx        # /docs/api
    auth.mdx         # /docs/api/auth
Enter fullscreen mode Exit fullscreen mode

MDX with Components 

---
title: "Getting Started"
description: "Quick start guide"
---

import { Tab, Tabs } from "fumadocs-ui/components/tabs";
import { Callout } from "fumadocs-ui/components/callout";

<Callout type="info">This guide takes 5 minutes.</Callout>

<Tabs items={["npm", "pnpm", "yarn"]}>
<Tab value="npm">npm install my-lib</Tab>
<Tab value="pnpm">pnpm add my-lib</Tab>
<Tab value="yarn">yarn add my-lib</Tab>
</Tabs>
Enter fullscreen mode Exit fullscreen mode

Search 

import { createSearchAPI } from "fumadocs-core/search/server";

export const { GET } = createSearchAPI("advanced", { indexes: allDocs });
Enter fullscreen mode Exit fullscreen mode

Key Features

  • Next.js App Router native
  • MDX with custom components
  • Full-text search built-in
  • OpenAPI docs generation
  • Dark mode, TOC, breadcrumbs
  • i18n support

Need to scrape or monitor web data at scale? Check out my web scraping actors on Apify or email spinov001@gmail.com for custom solutions.

Top comments (0)