Doctave

Doctave è una piattaforma di documentazione che combina la flessibilità della scrittura in Markdown con la potenza dell’hosting professionale della documentazione. Scrivi la tua documentazione in file di testo semplice, li archivi in Git insieme al tuo codice, e Doctave si occupa di trasformarli in splendidi siti web di documentazione ricercabili.

La piattaforma supporta sia guide in Markdown tradizionale sia specifiche OpenAPI per la documentazione delle API. Crea automaticamente ambienti di anteprima quando apporti modifiche, così il tuo team può rivedere gli aggiornamenti prima della pubblicazione. Tutto rimane nel tuo repository Git, garantendoti il pieno controllo delle versioni della documentazione.

Doctave Studio è l’applicazione desktop complementare che offre anteprime in tempo reale, suggerimenti di completamento automatico, controllo dei link interrotti e controllo ortografico. Insieme, questi strumenti aiutano i team a creare documentazione sempre aggiornata e precisa.

Iniziare con Doctave è semplice. Ecco come usarlo efficacemente:

• Crea una cartella di documentazione nel tuo repository di codice e scrivi i tuoi contenuti utilizzando file Markdown. Includi un file README.md come pagina iniziale.

• Installa Doctave Studio sul tuo computer per visualizzare in anteprima la documentazione localmente con aggiornamenti in tempo reale mentre scrivi.

• Configura il file doctave.yml per definire la struttura della documentazione, i colori del tema e i link di navigazione.

• Collega il tuo repository Git a Doctave tramite la loro piattaforma. Ogni volta che esegui un push delle modifiche, Doctave aggiorna automaticamente la documentazione pubblicata.

• Per la documentazione API, aggiungi il file di specifica OpenAPI al tuo repository. Doctave genererà automaticamente pagine di riferimento API interattive.

• Usa i branch di Git per gestire diverse versioni della documentazione. Crea pull request per revisionare le modifiche prima della pubblicazione e Doctave genererà link di anteprima per ogni pull request.

• Flusso di lavoro per la documentazione basato su Git con controllo delle versioni

• Editor desktop Doctave Studio con anteprima in tempo reale

• Supporto per specifiche OpenAPI per la documentazione delle API

• Ambientazioni di anteprima automatiche per le pull request

• Gestione della documentazione multi-versione

• Ricerca integrata in tutti i contenuti

• Opzioni di personalizzazione del branding e del tema

• Analisi dei lettori e raccolta di feedback

• Integrazione CI/CD per il deployment automatico

• Opzioni di documentazione protetta da password