Fumadocs

Fumadocs é uma estrutura de documentação que ajuda desenvolvedores a criar sites de documentação profissionais usando React e Next.js. Diferente das ferramentas tradicionais de documentação, ela oferece controle total sobre seu conteúdo e design, enquanto gerencia automaticamente as partes complexas.

Suporta a escrita de conteúdo em Markdown e MDX, o que significa que você pode usar formatação de texto simples ou adicionar componentes React interativos. A estrutura inclui busca integrada, realce de sintaxe e belos temas pré-projetados. Também funciona com qualquer fonte de conteúdo, seja armazenando seus documentos em arquivos, banco de dados ou sistema de gerenciamento de conteúdo.

Fumadocs é construída em torno de três partes: uma camada de conteúdo para gerenciar seus documentos, uma biblioteca central para recursos como busca, e uma biblioteca de interface para componentes bonitos. Você pode usar apenas o que precisar.

Começar com o Fumadocs é simples. Aqui estão os passos:

• Instale o framework executando o comando npm create fumadocs-app no seu terminal. Escolha seu framework React preferido e a fonte de conteúdo quando solicitado.

• Escreva seu conteúdo em arquivos MDX dentro da pasta docs. Use sintaxe Markdown simples com a opção de adicionar componentes React para elementos interativos.

• Personalize a aparência usando Tailwind CSS. Você pode alterar cores, layouts e estilos para combinar com sua marca sem precisar aprender um novo sistema.

• Adicione funcionalidade de busca conectando a busca Orama ou Algolia com apenas algumas linhas de código. O framework cuida do resto automaticamente.

• Use a ferramenta CLI para adicionar componentes interativos como abas, chamadas e blocos de código com o comando npx @fumadocs/cli add.

• Faça o deploy do seu site no Vercel, Netlify ou qualquer serviço de hospedagem que suporte aplicações Next.js.

• Framework gratuito e de código aberto

• Funciona com Next.js, React Router e outros frameworks React

• Escreva conteúdo em Markdown e MDX

• Busca integrada com suporte a Orama e Algolia

• Gerador de documentação OpenAPI

• Integração TypeScript Twoslash

• Componentes de UI pré-projetados e bonitos

• Ferramenta de linha de comando para configuração fácil

• Destaque de sintaxe com Shiki

• Altamente personalizável com Tailwind CSS