Genera documentazione con i file Markdown utilizzando Docsify

Se stai creando un plugin gratuito, un framework o uno script open source avrai bisogno di documentazione. È fondamentale per documenta il tuo lavoro, sia per la tua sanità mentale sia per aiutare gli altri che vogliono imparare la tua fantastica risorsa.

Tuttavia, la creazione di documentazione online può essere un vero problema. Per fortuna, Docsify rende più facile fornendo un generatore di documentazione gratuito in esecuzione su Markdown.

Questo è non un generatore di sito statico tipico e lo fa non richiede pagine HTML / CSS statiche. Invece carica i file Markdown dinamicamente e li visualizza come pagine web. Piuttosto pulito!

Controlla la homepage di Docsify per a anteprima del layout, insieme a ulteriori dettagli sulla configurazione.

Richiede te crea tu stesso il file index.html, che può quindi essere caricato su GitHub Pages o ospitato sul proprio server. Da lì, tu solo scrivi i file Markdown per ogni pagina e usa quelli come documenti principali.

L'intero processo è delineato in dettaglio nel Guida Rapida, quindi questo è probabilmente il miglior punto di partenza. Questo può tutti corrono attraverso npm, quindi aiuta davvero a conoscere il tuo prompt dei comandi o almeno a voler imparare.

È possibile creare autonomamente un file HTML grezzo e copiare / incollare il modello dalla guida all'installazione di Docsify. Ma, lo raccomando farlo dinamicamente, dal momento che risparmia un sacco di tempo - e non è proprio questo il punto?

Quando impari il sistema Docsify, puoi farlo aggiungere funzionalità utilizzando Markdown o HTML non elaborato. Queste funzionalità includono a barra di navigazione personalizzata e persino la tua pagina di copertina con il logo del tuo progetto.

Docsify anche viene confezionato con un mucchio di temi gratuiti se vuoi lavorare con i layout pre-progettati. O puoi sfogliare la loro galleria di vetrine per vedere quali progetti utilizzano Docsify per la loro documentazione.

Tutti i informazioni di base sull'installazione e download di file può essere trovato su GitHub, quindi andate lì se volete dare una possibilità.

Puoi anche vedere una demo dal vivo nella pagina principale della documentazione di Docsify che, abbastanza sicuro, funziona su Docsify. Quindi, se ti piace il layout di questa pagina web, puoi utilizzare lo stesso modello ed eseguirlo tutto tramite Docsify, completamente gratuito e open source.