Generirajte dokumentaciju s Markdown datotekama pomoću Docsify
Ako stvarate besplatni dodatak, okvir ili skriptu otvorenog koda trebat će vam dokumentacija. To je ključno za dokumentirajte svoj rad, i za vaš zdrav razum i za pomoć drugima koji žele naučiti vaš strašan resurs.
Međutim, stvaranje online dokumentacije može biti pravi bol. zahvaljujući, Docsify olakšava nam pružanje besplatni generator dokumentacije koji radi na Markdown-u.
Ovo je nije tipičan statički generator stranica i to čini ne zahtijevaju statične HTML / CSS stranice. Umjesto toga učitava Markdown datoteke dinamički i prikazuje ih kao web-stranice. Prilično lijepo!
Pogledajte početnu stranicu Docsify za pregled izgleda, zajedno s pojedinosti o daljnjem podešavanju.
To zahtijeva da vi sami izradite datoteku index.html, koji se zatim može prenijeti na GitHub stranice ili hostirati na vlastitom poslužitelju. Odatle, vi samo napišite Markdown datoteke za svaku stranicu i koristite ih kao primarne dokumente.
Cijeli proces detaljno je opisan u brzi vodič, tako da je to vjerojatno najbolje mjesto za početak. Ovo može sve teče kroz npm, tako da stvarno pomaže znati vaš naredbeni redak ili barem biti voljni učiti.
Moguće je sami stvoriti sirovu HTML datoteku i jednostavno kopirati / zalijepiti predložak iz vodiča za postavljanje programa Docsify. Ali, preporučujem to radimo dinamički, jer štedi tonu vremena - i nije li to doista bitno?
Dok učite sustav Docsify, možete dodajte značajke pomoću značajke Markdown ili neobrađenog HTML-a. Te značajke uključuju a prilagođena navigacijska traka pa čak i svoju naslovnicu s logotipom vašeg projekta.
Dokumentirajte čak i dolazi s hrpom besplatnih tema ako želite unaprijed dizajniran raspored raditi. Ili, možete pregledajte njihovu galeriju izloga vidjeti koji projekti koriste dokumentaciju za svoju dokumentaciju.
Svi osnovne informacije o instalaciji i preuzimanju datoteka može se naći na GitHubu, pa idite tamo ako želite dati ovu snimku.
Također možete pogledajte demo uživo na glavnoj stranici dokumentacije Docsify koji, naravno, radi na dokumentaciji. Dakle, ako vam se sviđa taj izgled web-stranice možete koristiti isti predložak i pokrenuti ga kroz Dokumenti, 100% besplatno i otvorenog koda.
