Dokumentáció készítése a Marksif Files segítségével a Docsify használatával

Ha ingyenes plugint, keretrendszert vagy nyílt forráskódú szkriptet hoz létre dokumentációra lesz szüksége. Ez döntő fontosságú dokumentálja munkáját, mind az egészségedért, mind a másoknak, akik meg akarják tanulni a félelmetes erőforrásaidat.

Az online dokumentáció létrehozása azonban valódi fájdalom lehet. hálásan, Docsify megkönnyíti az a ingyenes dokumentációs generátor fut a Markdown-on.

Ez nem tipikus statikus helygenerátor és nem nem igényel statikus HTML / CSS oldalakat. Ehelyett betölti a Markdown fájlokat dinamikusan és megjeleníti azokat weboldalakként. Elég ügyes!

Nézze meg a Docsify honlapját az a az elrendezés előnézete, együtt további beállítási részletek.

Ez megköveteli, hogy hozza létre az index.html fájlt, ezután feltölthető a GitHub oldalakra, vagy saját kiszolgálón tárolható. Innen csak te minden oldalhoz írjon le Markdown fájlokat és használja ezeket az elsődleges dokumentumokként.

A teljes folyamatot részletesen vázoljuk a gyors üzembe helyezési útmutató, így ez talán a legjobb hely az induláshoz. Ez lehet az összes npm-en keresztül fut, így valóban segít megismerni a parancssorodat, vagy legalább hajlandó tanulni.

Lehetőség van egy nyers HTML fájl létrehozására is, és csak másolja / illessze be a sablont a Docsify telepítési útmutatójából. De ajánlom dinamikusan, mivel időt takarít meg, és nem igazán ez a lényeg?

Ahogy megtanulod a Docsify rendszert, tudod funkciók hozzáadása a Markdown vagy a nyers HTML használatával. Ezek a funkciók a egyéni navigációs sáv sőt még saját fedőlapját a projekt logójával.

Dolgozzon még jön egy csomó ingyenes téma ha előre tervezett elrendezéseket szeretne használni. Vagy tudsz böngésszen a galériájukban hogy lássák, mely projektek használják dokumentációjukhoz a Docsify-t.

Mind a alapvető beállítási információk és fájl letöltések megtalálható a GitHub-on, ezért menj oda, ha meg akarod adni ezt a lövést.

Te is nézd meg az élő bemutatót a fő Docsify dokumentációs oldalon ami biztosan a Docsify-n fut. Tehát, ha tetszik a weblap elrendezése, akkor ugyanazt a sablont használhatja, és a Docsify, 100% ingyenes és nyílt forráskódú összes futtatásával.