Generați documentația cu fișiere Markdown utilizând Docsify
Dacă creați un plugin gratuit, cadru sau script open-source veți avea nevoie de documentație. Este crucial să documentați-vă munca, atât pentru sanatatea ta, cât și pentru a ajuta pe ceilalți care doresc să învețe resursele tale minunate.
Cu toate acestea, crearea de documentație online poate fi o adevărată durere. din fericire, Docsify facilitează furnizarea unui serviciu generator gratuit de documentație care rulează pe Markdown.
Aceasta este nu un generator tipic de site static și așa este nu necesită pagini statice HTML / CSS. În schimb, asta încarcă fișiere Markdown dinamic și le afișează ca pagini web. Destul de curat!
Consultați pagina de pornire Docsify pentru a previzualizare a aspectului, impreuna cu mai multe detalii de configurare.
E nevoie de tine creați singur fișierul index.html, care pot fi încărcate în paginile GitHub sau găzduite pe propriul server. De acolo, tu doar scrieți fișiere Markdown pentru fiecare pagină și să le folosiți ca documente principale.
Întregul proces este prezentat în detaliu în Ghid de inițiere rapidă, astfel că este probabil cel mai bun loc pentru a începe. Acesta poate toate trec prin npm, astfel încât într-adevăr vă ajută să cunoașteți promptul de comandă sau cel puțin să fiți dispus să învățați.
Este posibil să creați singur un fișier HTML brut și să copiați / inserați șablonul din ghidul de configurare al Docsify. Dar, vă recomand o face dinamic, deoarece economisește o tona de timp - și nu este chiar acel punct?
Pe măsură ce învățați sistemul Docsify, puteți adăugați caracteristici utilizând Markdown sau HTML brut. Aceste caracteristici includ a bară de navigare personalizată și chiar propria pagină de copertă cu sigla proiectului dumneavoastră.
Docsify chiar vine ambalat cu o grămadă de teme gratuite dacă doriți să lucrați cu machete pre-proiectate. Sau puteți navigați prin galeria lor de expoziții pentru a vedea care proiecte utilizează Docsify pentru documentația lor.
Toate setări de bază și descărcări de fișiere pot fi găsite pe GitHub, deci îndreptați-vă acolo dacă doriți să faceți acest lucru.
Poti de asemenea consultați o demonstrație live pe pagina principală de documentare Docsify care, cu siguranță, rulează pe Docsify. Deci, dacă vă place aspectul paginii web, puteți folosi același șablon și puteți rula toate documentele Docsify, 100% gratuit și open-source.