xyd

xyd is een documentatiekader waarmee je professionele documentatiewebsites kunt maken zonder te worstelen met complexe tools. Het wordt geleverd met zes prachtige ingebouwde thema's die je direct kunt gebruiken, of je kunt elk onderdeel aanpassen om bij je merk te passen. Het kader genereert automatisch documentatie op basis van je OpenAPI-, GraphQL-, TypeScript- en React-codespecificaties.

In tegenstelling tot andere documentatietools bevat xyd vanaf het begin alles wat je nodig hebt. Je krijgt volledige tekstzoekfunctie met slimme suggesties, ingebouwde analyses om te volgen hoe mensen je documentatie gebruiken, live chat-integratie en zelfs A/B-testmogelijkheden. De ontwikkelserver start direct op met hot reload, zodat je wijzigingen meteen ziet. Gemaakt door ontwikkelaars voor ontwikkelaars, haalt xyd de saaie onderdelen van het maken van documentatie weg, zodat jij je kunt concentreren op het schrijven van geweldige content.

Aan de slag gaan met xyd is eenvoudig. Hier zijn de stappen om je documentatie te maken:

• Installeer xyd globaal met het commando bun add -g xyd-js of je favoriete pakketbeheerder. Je hebt Node.js versie 22.12 of hoger nodig op je computer.

• Voer xyd uit in je projectmap om de ontwikkelserver te starten. Deze start direct met hot reload, wat betekent dat je je wijzigingen meteen ziet zonder opnieuw te hoeven starten.

• Kies uit zes ingebouwde thema’s of maak je eigen ontwerp. Elk thema biedt een andere stijl en lay-out die past bij de behoeften van je project.

• Schrijf je documentatie met het rijke contentframework dat interactieve componenten, live codevoorbeelden en dynamische elementen ondersteunt, waardoor je documentatie aantrekkelijker wordt.

• Voor API-documentatie wijs je xyd eenvoudig naar je OpenAPI-, GraphQL-, TypeScript- of React-specificaties en het genereert automatisch prachtige documentatie.

• Voer xyd build uit wanneer je klaar bent om statische bestanden te maken voor deployment naar elke hostingdienst.

• Zes prachtige ingebouwde thema's beschikbaar

• Automatische API-documentatie van OpenAPI, GraphQL, TypeScript, React

• Hot reload ontwikkelserver zonder configuratie

• Volledige aanpassing van alle componenten en lay-outs

• Rijk plugin-ecosysteem voor zoeken, analytics, chat

• Interactieve codevoorbeelden en dynamische inhoud

• Ingebouwde analytics en A/B-testondersteuning

• Bliksemsnelle full-text zoekfunctionaliteit

• Open source en volledig gratis

• Migratietools van andere frameworks