Sukurkite dokumentaciją su „Markdown“ failais naudojant „Docsify“

Jei kuriate nemokamą įskiepį, sistemą arba atviro kodo scenarijų jums reikės dokumentų. Tai labai svarbu dokumentuokite savo darbą, ir savo sveikatui, ir padėti kitiems, norintiems sužinoti savo nuostabų išteklių.

Tačiau internetinių dokumentų kūrimas gali būti tikras skausmas. dėkingai, Dokumentuoti palengvina teikiant a nemokama dokumentacijos generatorius, veikiantis „Markdown“.

Tai yra ne tipiškas statinis svetainės generatorius ir tai daro nereikalauja statinių HTML / CSS puslapių. Vietoj to, tai įkelia „Markdown“ failus dinamiškai ir rodo juos kaip tinklalapius. Gana tvarkingas!

Peržiūrėkite „Docsify“ pagrindinį puslapį a maketo peržiūra, kartu su tolesnės sąrankos detalės.

Tai reikalauja, kad jūs sukurkite failą index.html, kuris gali būti įkeltas į „GitHub Pages“ arba talpinamas jūsų serveryje. Iš ten jūs tiesiog rašyti kiekvieno puslapio „Markdown“ failus ir naudokite juos kaip pagrindinius dokumentus.

Visas procesas išsamiai aprašytas greitas pradmenų gidas, taigi tikriausiai tai geriausia vieta pradėti. Tai gali visi veikia per npm, todėl tai tikrai padeda žinoti savo komandų eilutę arba bent jau pasiruošti mokytis.

Galima patys sukurti neapdorotą HTML failą ir tiesiog nukopijuoti / įklijuoti šabloną iš „Docsify“ sąrankos vadovo. Bet aš rekomenduoju dinamiškai, nes jis taupo toną laiko, o ne tai tikrai?

Sužinodami „Docsify“ sistemą, galite pridėti funkcijų naudodami „Markdown“ arba „raw“ HTML. Šios funkcijos apima: a pasirinktinį naršymo juostą Ir netgi savo viršelio puslapį su projekto logotipu.

Doksifikuoti ateina supakuota su nemokama temomis jei norite, kad iš anksto suplanuoti maketai veiktų. Arba galite naršyti savo vitrinos galerijoje norėdami sužinoti, kurie projektai naudoja dokumentaciją „Docsify“.

Visi pagrindinė sąrankos informacija ir failų atsisiuntimas galima rasti „GitHub“, todėl nueikite ten, jei norite tai padaryti.

Tu taip pat gali žiūrėkite gyvą demonstraciją pagrindiniame Docsify dokumentacijos puslapyje kuris, žinoma, vyksta „Docsify“. Taigi, jei jums patinka šis tinklalapio išdėstymas, galite naudoti tą patį šabloną ir paleisti jį visa per „Docsify“, 100% nemokamą ir atvirą kodą.