Fumadocs

Fumadocs is een documentatiekader dat ontwikkelaars helpt professionele documentatiesites te bouwen met React en Next.js. In tegenstelling tot traditionele documentatietools geeft het je volledige controle over je inhoud en ontwerp, terwijl het de complexe onderdelen automatisch afhandelt.

Het ondersteunt het schrijven van content in Markdown en MDX, wat betekent dat je eenvoudige tekstopmaak kunt gebruiken of interactieve React-componenten kunt toevoegen. Het kader bevat ingebouwde zoekfunctie, syntaxiskleuring en prachtige vooraf ontworpen thema's. Het werkt ook met elke contentbron, of je je documentatie nu opslaat in bestanden, een database of een contentmanagementsysteem.

Fumadocs is opgebouwd uit drie delen: een contentlaag voor het beheren van je documentatie, een kernbibliotheek voor functies zoals zoeken, en een UI-bibliotheek voor mooie componenten. Je kunt alleen gebruiken wat je nodig hebt.

Beginnen met Fumadocs is eenvoudig. Hier zijn de stappen:

• Installeer het framework door het commando npm create fumadocs-app in je terminal uit te voeren. Kies je favoriete React-framework en inhoudsbron wanneer daarom wordt gevraagd.

• Schrijf je inhoud in MDX-bestanden binnen de map docs. Gebruik eenvoudige Markdown-syntaxis met de optie om React-componenten toe te voegen voor interactieve elementen.

• Pas het uiterlijk aan met Tailwind CSS. Je kunt kleuren, lay-outs en stijlen wijzigen om bij je merk te passen zonder een nieuw systeem te hoeven leren.

• Voeg zoekfunctionaliteit toe door Orama of Algolia-zoekopdrachten te koppelen met slechts een paar regels code. Het framework regelt de rest automatisch.

• Gebruik de CLI-tool om interactieve componenten zoals tabbladen, callouts en codeblokken toe te voegen met het commando npx @fumadocs/cli add.

• Implementeer je site op Vercel, Netlify of een andere hostingdienst die Next.js-applicaties ondersteunt.

• Gratis en open-source framework

• Werkt met Next.js, React Router en andere React-frameworks

• Schrijf content in Markdown en MDX

• Ingebouwde zoekfunctie met ondersteuning voor Orama en Algolia

• OpenAPI documentatiegenerator

• TypeScript Twoslash-integratie

• Prachtige vooraf ontworpen UI-componenten

• Commandoregeltool voor eenvoudige installatie

• Syntax highlighting met Shiki

• Sterk aanpasbaar met Tailwind CSS