Generovanie dokumentácie pomocou súborov Markdown pomocou nástroja Docsify

Ak vytvárate bezplatný doplnok, rámec alebo skript s otvoreným zdrojovým kódom budete potrebovať dokumentáciu. Je to dôležité dokumentujte svoju prácu, ako aj pre vašu duševnú pohodu a pomáhať ostatným, ktorí sa chcú naučiť váš úžasný zdroj.

Vytvorenie online dokumentácie však môže byť skutočnou bolesťou. Našťastie, Docsify uľahčuje poskytnutím služby free generátor dokumentácie beží na Markdown.

Toto je nie je typický generátor statických stránok a to robí nevyžadujú statické stránky HTML / CSS. Namiesto toho načíta súbory Markdown dynamicky a zobrazí ich ako webové stránky. Docela čistý!

Pozrite sa na domovskú stránku služby Docsify a náhľad rozloženia, spolu s ďalšie podrobnosti o nastavení.

Vyžaduje to, aby ste vy vytvorte súbor index.html sami, ktoré sa potom môžu nahrať na stránky GitHub alebo hostiť na vlastnom serveri. Odtiaľ ste práve písať súbory Markdown pre každú stránku a použite ich ako svoje primárne dokumenty.

Celý proces je podrobne opísaný v návod na rýchlu inštaláciu, takže je to asi najlepšie miesto na začatie. To môže všetky prejdú npm, takže to naozaj pomáha poznať príkazový riadok alebo aspoň byť ochotný sa naučiť.

Je možné vytvoriť sami raw HTML súbor a skopírujte / prilepte šablónu zo sprievodcu nastavením Docsify. Ale odporúčam robiť to dynamicky, pretože šetrí tónu času - a nie je to naozaj bod?

Keď sa naučíte systém Docsify, môžete pridať funkcie pomocou Markdown alebo raw HTML. Medzi tieto funkcie patrí a vlastný navigačný panel a dokonca vlastnú titulnú stránku s logom vášho projektu.

Dokumentovať dokonca je dodávaný zabalený s množstvom voľných tém ak chcete pracovať s vopred navrhnutými rozloženiami. Alebo môžete Prehliadajte si ich galériu ukážok aby ste zistili, ktoré projekty používajú Docsify pre svoju dokumentáciu.

Všetko základné informácie o nastavení a sťahovanie súborov môžete nájsť na GitHub, a tak tam hneď, ak chcete dať to výstrel.

Môžete tiež pozrite si živé ukážky na hlavnej stránke dokumentácie Dokumentácia ktorý, naozaj, funguje na Docsify. Takže ak sa vám páči rozloženie webovej stránky, môžete použiť rovnakú šablónu a spustiť ju cez Docsify, 100% zadarmo a open source.