Docusaurus

Docusaurus is een statische sitegenerator gebouwd met React en Node.js. Het neemt je Markdown-bestanden en creëert een complete documentatiewebsite met alle functies die gebruikers verwachten. In tegenstelling tot het vanaf nul bouwen van een website, regelt Docusaurus de moeilijke onderdelen voor jou.

De tool gebruikt MDX, wat betekent dat je interactieve React-componenten direct in je Markdown-bestanden kunt toevoegen. Dit maakt je documentatie boeiender zonder extra werk. Het wordt geleverd met ingebouwde zoekfunctie aangedreven door Algolia, versiebeheer voor verschillende productreleases en ondersteuning voor meer dan 70 talen via vertaaltools.

Omdat het statische bestanden creëert, laadt je documentatie snel en kan overal worden gehost. De sites werken uitstekend op mobiele apparaten en volgen moderne webstandaarden voor snelheid en toegankelijkheid.

Aan de slag gaan met Docusaurus is eenvoudig en duurt slechts een paar minuten:

• Installeer Node.js versie 20 of hoger op je computer, en voer vervolgens het setup-commando uit in je terminal om een nieuwe site aan te maken.

• Schrijf je documentatie in Markdown-bestanden in de map docs. Elk bestand wordt een pagina op je website.

• Pas de uitstraling aan door het configuratiebestand te bewerken. Je kunt kleuren wijzigen, je logo toevoegen en navigatiemenu's instellen.

• Gebruik het lokale preview-commando om wijzigingen direct in je browser te zien terwijl je werkt.

• Voeg blogposts toe door Markdown-bestanden te maken in de map blog met datums in de bestandsnaam.

• Wanneer je klaar bent om te publiceren, voer je het build-commando uit om statische bestanden te genereren, en upload je deze vervolgens naar een webhost zoals GitHub Pages, Netlify of Vercel.

De tool bevat gedetailleerde handleidingen en een behulpzame community als je vastloopt.

• Gratis en open source met MIT-licentie

• Gebouwd met React en Node.js

• Schrijf inhoud in Markdown en MDX

• Ingebouwde zoekfunctie met Algolia DocSearch

• Versiebeheer voor productreleases

• Ondersteuning voor meer dan 70 talen

• Blog en documentatie op één site

• Donkere modus en responsief ontwerp

• Snelle statische sitegeneratie

• Eenvoudige implementatie naar elke host