xyd

xyd è un framework per la documentazione che ti permette di creare siti web di documentazione professionali senza dover affrontare strumenti complessi. Include sei splendidi temi integrati che puoi usare subito, oppure puoi personalizzare ogni parte per adattarla al tuo brand. Il framework genera automaticamente la documentazione dalle tue specifiche OpenAPI, GraphQL, TypeScript e React.

A differenza di altri strumenti per la documentazione, xyd include tutto ciò di cui hai bisogno fin dall'inizio. Offre una ricerca full-text con suggerimenti intelligenti, analisi integrate per monitorare come gli utenti utilizzano la documentazione, integrazione con chat live e persino funzionalità di A/B testing. Il server di sviluppo si avvia istantaneamente con hot reload, così puoi vedere le modifiche immediatamente. Creato da sviluppatori per sviluppatori, xyd elimina le parti noiose della creazione della documentazione, permettendoti di concentrarti sulla scrittura di contenuti eccellenti.

Iniziare con xyd è semplice. Ecco i passaggi per creare la tua documentazione:

• Installa xyd globalmente usando il comando bun add -g xyd-js o il tuo gestore di pacchetti preferito. È necessario avere installato sul computer Node.js versione 22.12 o superiore.

• Esegui xyd nella cartella del tuo progetto per avviare il server di sviluppo. Si avvia istantaneamente con hot reload, il che significa che puoi vedere le modifiche apparire immediatamente senza dover riavviare.

• Scegli tra sei temi integrati o crea un design personalizzato. Ogni tema offre uno stile e un layout diversi per adattarsi alle esigenze del tuo progetto.

• Scrivi la tua documentazione utilizzando il framework di contenuti avanzato che supporta componenti interattivi, esempi di codice live ed elementi dinamici che rendono i tuoi documenti più coinvolgenti.

• Per la documentazione API, basta indicare a xyd le tue specifiche OpenAPI, GraphQL, TypeScript o React e genera automaticamente una documentazione elegante.

• Esegui xyd build quando sei pronto per creare file statici da distribuire su qualsiasi servizio di hosting.

• Sei bellissimi temi integrati disponibili

• Documentazione API automatica da OpenAPI, GraphQL, TypeScript, React

• Server di sviluppo con hot reload e zero configurazioni

• Personalizzazione completa di tutti i componenti e layout

• Ricco ecosistema di plugin per ricerca, analisi, chat

• Esempi di codice interattivi e contenuti dinamici

• Supporto integrato per analisi e test A/B

• Funzionalità di ricerca full-text ultra veloce

• Open source e completamente gratuito

• Strumenti di migrazione da altri framework