Izveidot dokumentāciju ar Markdown failiem, izmantojot Docsify
Ja izveidojat bezmaksas spraudni, ietvaru vai atvērtā koda skriptu jums būs nepieciešama dokumentācija. Tas ir ļoti svarīgi dokumentēt savu darbu, gan jūsu veselībai, gan palīdzot citiem, kas vēlas uzzināt par jūsu lielisko resursu.
Tomēr tiešsaistes dokumentācijas izveide var būt reāla sāpes. Par laimi, Dokumentēt atvieglo, nodrošinot a bezmaksas dokumentācijas ģenerators, kas darbojas Markdown.
Tas ir nav tipisks statiskā vietnes ģenerators un tā dara nav nepieciešamas statiskas HTML / CSS lapas. Tā vietā ielādē Markdown failus dinamiski un parāda tos kā tīmekļa lapas. Diezgan veikls!
Pārbaudiet Docsify mājas lapu a izkārtojuma priekšskatījums, kopā ar sīkākas detaļas.
Tas prasa, lai jūs izveidojiet failu index.html, kuru pēc tam var augšupielādēt GitHub Pages vai izvietot savā serverī. No turienes jūs vienkārši uzrakstiet Markdown failus katrai lapai un izmantojiet tos kā galvenos dokumentus.
Viss process ir sīki izklāstīts Ātrā pamācība, tā, iespējams, ir labākā vieta, kur sākt. Tas var visi darbojas caur npm, tāpēc tas tiešām palīdz uzzināt jūsu komandu uzvedni vai vismaz gatavi mācīties.
Iespējams pats izveidot neapstrādātu HTML failu un vienkārši kopēt / ielīmēt veidni no Docsify iestatīšanas rokasgrāmatas. Bet es ieteiktu dinamiski, jo tas ietaupa tonu laika, un tas nav īstais punkts?
Kad jūs uzzināsiet Docsify sistēmu, jūs varat pievienot funkcijas, izmantojot Markdown vai neapstrādātu HTML. Šīs funkcijas ietver a pielāgotu navigācijas joslu un pat savu vāka lapu ar projekta logo.
Dokumentējiet pat nāk komplektā ar bezmaksas tēmām ja vēlaties, lai iepriekš izstrādātie izkārtojumi darbotos. Vai arī varat pārlūkojiet savu vitrīna galeriju lai noskaidrotu, kuri projekti dokumentācijai izmanto Docsify.
Visi pamata iestatīšanas informācija un failu lejupielāde var atrast GitHub, tāpēc dodieties uz turieni, ja vēlaties to darīt.
Jūs varat arī skatiet tiešo demonstrāciju galvenajā Docsify dokumentācijas lapā kas, protams, darbojas uz Docsify. Tātad, ja jums patīk šis tīmekļa lapas izkārtojums, jūs varat izmantot to pašu veidni un palaist to visu, izmantojot Docsify, 100% bezmaksas un atvērtā koda.
