xyd

xyd est un cadre de documentation qui vous permet de créer des sites web de documentation professionnels sans lutter avec des outils complexes. Il propose six magnifiques thèmes intégrés que vous pouvez utiliser immédiatement, ou vous pouvez personnaliser chaque élément pour correspondre à votre marque. Le cadre génère automatiquement la documentation à partir de vos spécifications OpenAPI, GraphQL, TypeScript et React.

Contrairement à d'autres outils de documentation, xyd inclut tout ce dont vous avez besoin dès le départ. Vous bénéficiez d'une recherche en texte intégral avec des suggestions intelligentes, d'analyses intégrées pour suivre l'utilisation de vos documents, d'une intégration de chat en direct, et même de capacités de tests A/B. Le serveur de développement démarre instantanément avec rechargement à chaud, vous permettant de voir les modifications immédiatement. Conçu par des développeurs pour des développeurs, xyd élimine les parties ennuyeuses de la création de documentation afin que vous puissiez vous concentrer sur la rédaction de contenu de qualité.

Commencer avec xyd est simple. Voici les étapes pour créer votre documentation :

• Installez xyd globalement en utilisant la commande bun add -g xyd-js ou votre gestionnaire de paquets préféré. Vous devez avoir Node.js version 22.12 ou supérieure installé sur votre ordinateur.

• Exécutez xyd dans le dossier de votre projet pour démarrer le serveur de développement. Il se lance instantanément avec rechargement à chaud, ce qui signifie que vous pouvez voir vos modifications apparaître immédiatement sans redémarrer.

• Choisissez parmi six thèmes intégrés ou créez votre propre design personnalisé. Chaque thème offre un style et une mise en page différents pour correspondre aux besoins de votre projet.

• Rédigez votre documentation en utilisant le cadre de contenu riche qui prend en charge les composants interactifs, les exemples de code en direct et les éléments dynamiques qui rendent vos docs plus attrayantes.

• Pour la documentation API, il suffit d’indiquer à xyd vos spécifications OpenAPI, GraphQL, TypeScript ou React et il génère automatiquement une documentation élégante.

• Exécutez xyd build lorsque vous êtes prêt à créer des fichiers statiques pour le déploiement sur n’importe quel service d’hébergement.

• Six magnifiques thèmes intégrés disponibles

• Documentation API automatique à partir de OpenAPI, GraphQL, TypeScript, React

• Serveur de développement à rechargement à chaud sans configuration

• Personnalisation complète de tous les composants et mises en page

• Écosystème riche de plugins pour la recherche, l’analyse, le chat

• Exemples de code interactifs et contenu dynamique

• Support intégré pour l’analyse et les tests A/B

• Fonctionnalité de recherche en texte intégral ultra-rapide

• Open source et totalement gratuit

• Outils de migration depuis d’autres frameworks