MkDocs

MkDocs is een documentatiegenerator die Markdown-bestanden omzet in complete statische HTML-websites. Je schrijft je inhoud in Markdown, een eenvoudig tekstformaat dat iedereen binnen enkele minuten kan leren. MkDocs verwerkt deze bestanden vervolgens en creëert een volledige website met navigatie, zoekfunctie en een mooi ontwerp.

De tool bevat een ingebouwde ontwikkelserver die je live previews toont terwijl je typt. Dit betekent dat je veranderingen direct ziet zonder je browser handmatig te hoeven verversen. MkDocs wordt geleverd met twee ingebouwde thema’s en ondersteunt vele door de community gemaakte thema’s, zoals het populaire Material for MkDocs.

Aangezien MkDocs statische bestanden creëert, laadt je documentatie snel en kan deze overal gehost worden zonder dat er complexe serverconfiguraties of databases nodig zijn.

Aan de slag met MkDocs is eenvoudig:

• Installeer Python op je computer als je het nog niet hebt. MkDocs heeft Python 3.8 of nieuwer nodig om goed te werken.

• Installeer MkDocs met het commando: pip install mkdocs. Dit downloadt en zet alles op wat je nodig hebt.

• Maak een nieuw project aan door het commando uit te voeren: mkdocs new my-project. Dit maakt een map aan met een basisstructuur inclusief een configuratiebestand en voorbeelddocumentatie.

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

• Bekijk een voorbeeld van je werk door het commando uit te voeren: mkdocs serve. Dit start een lokale server, meestal op http://127.0.0.1:8000, waar je je documentatie in realtime kunt zien.

• Bouw je definitieve website met: mkdocs build. Dit maakt een site-map aan met alle HTML-bestanden die klaar zijn om gepubliceerd te worden.

• Publiceer je documentatie op GitHub Pages of een andere webhostingdienst met mkdocs gh-deploy voor GitHub of door de inhoud van de site-map te uploaden.

• Documentatie schrijven op basis van Markdown

• Live preview met automatische browserverversing

• Ondersteuning voor ingebouwde en externe thema's

• Enkel YAML-configuratiebestand

• Plug-insysteem voor uitgebreide functionaliteit

• Genereert snelle statische HTML-sites

• Geïntegreerde zoekfunctie zonder externe diensten

• Overal te implementeren (GitHub Pages, Netlify, enz.)

• Open source en volledig gratis

• Actieve community-ondersteuning en ontwikkeling