Ustvarite dokumentacijo z Markdown datotekami z uporabo Docsify
Če ustvarjate brezplačen vtičnik, okvir ali skript z odprto kodo potrebovali boste dokumentacijo. To je ključnega pomena za dokumentirajte svoje delo, tako za vaš razum in za pomoč drugim, ki se želijo naučiti svojega izjemnega vira.
Vendar pa je ustvarjanje spletne dokumentacije lahko resnična bolečina. Na srečo, Dokumentirajte olajša z zagotavljanjem brezplačen generator dokumentacije, ki deluje na Markdown.
To je ni tipičen statični generator mesta in to počne ne zahtevajo statičnih strani HTML / CSS. Namesto tega naloži Markdown datoteke dinamično in jih prikaže kot spletne strani. Precej lepo!
Oglejte si domačo stran Docsify za a predogled postavitve, skupaj z podrobnosti o nastavitvi.
To zahteva, da vas sami ustvarite datoteko index.html, ki jih lahko nato naložite na GitHub strani ali gostite na svojem strežniku. Od tam, vi prav napišite Markdown datoteke za vsako stran in jih uporabite kot primarne dokumente.
Celoten proces je podrobno opisan v. \ T priročnik za hiter začetek, to je verjetno najboljši kraj za začetek. To lahko vse tečejo skozi npm, tako da resnično pomaga vedeti vaš ukazni poziv ali vsaj biti pripravljeni na učenje.
Sami lahko ustvarite surovo datoteko HTML in preprosto kopirate / prilepite predlogo iz vodnika za namestitev programa Docsify. Ampak, priporočam to počnemo dinamično, ker prihrani tono časa - in ni to res bistvo?
Ko se naučite sistema Docsify, lahko dodajte funkcije, ki uporabljajo Markdown ali surovi HTML. Te funkcije vključujejo a navigacijska vrstica po meri in celo lastno naslovnico z logotipom vašega projekta.
Dokumentirajte celo prihaja s kupom brezplačnih tem če želite vnaprej oblikovane postavitve delati. Ali pa lahko brskajte po galeriji izložb da bi videli, kateri projekti uporabljajo dokumentacijo za svojo dokumentacijo.
Vse osnovne informacije o namestitvi in prenosi datotek lahko najdete na GitHubu, zato nadaljujte tja, če želite dati ta posnetek.
Lahko tudi si oglejte demo v živo na glavni strani dokumentacije Docsify ki, seveda dovolj, deluje na Docsify. Torej, če vam je všeč ta postavitev spletne strani, lahko uporabite isto predlogo in jo poganjate skozi dokumente, ki so 100% brezplačni in odprtokodni.
