Loo dokumentatsioon Marksif Files abil Docsify abil

Kui loote tasuta plugina, raamistiku või avatud lähtekoodiga skripti peate dokumentatsiooni. See on väga oluline dokumenteerige oma töö, nii teie meelerahu kui ka teiste abistamiseks, kes tahavad õppida teie vinge ressurssi.

Siiski võib veebipõhise dokumentatsiooni loomine olla tõeline valu. Õnneks, Docsify lihtsustab a tasuta dokumentatsioonigeneraator, mis töötab Markdownis.

See on mitte tüüpiline staatiline saidigeneraator ja see teeb ei vaja staatilisi HTML / CSS-lehekülgi. Selle asemel laadib Markdowni faile dünaamiliselt ja kuvab need veebilehtedena. Päris puhas!

Vaadake Docsify kodulehte a paigutuse eelvaade, koos edasised seadistamise üksikasjad.

See nõuab, et sa loo index.html fail ise, mida saab seejärel üles laadida GitHub Pages'i või majutada teie enda serveris. Sealt sa lihtsalt kirjutage igale lehele Markdown-failid ja kasutage neid oma peamiste dokumentidena.

Kogu protsess on üksikasjalikult kirjeldatud lühike juhend, nii et see on ilmselt parim koht alustamiseks. See võib kõik jooksevad läbi npm, nii et see aitab tõesti tunda teie käsurea või vähemalt olla valmis õppima.

Toores HTML-fail on võimalik ise luua ja kopeerida / kleepida malli Docsify seadistusjuhendist. Aga ma soovitan tehes seda dünaamiliselt, kuna see säästab tonni aega ja see pole tegelikult nii?

Kui õpid Docsify süsteemi, saate seda teha lisage funktsioone Markdowni või toores HTML-i abil. Need funktsioonid hõlmavad a kohandatud navigeerimisriba ja isegi oma kaanelehe oma projekti logoga.

Dokumenteerige isegi on pakitud hulga tasuta teemasid kui soovite eelnevalt kavandatud paigutusega töötada. Või saate sirvige oma presentatsioonigalerii näha, millised projektid dokumenteerimiseks kasutavad Docsify't.

Kõik põhilised seadistusinfo ja failide allalaadimine võib leida GitHubist, nii et pea sealt üle, kui soovite seda teha.

Sa saad ka vaata peamist Docsify dokumentatsiooni lehekülge mis kindlasti on Docsify'l. Niisiis, kui sulle meeldib see veebilehe paigutus, saate seda sama malli kasutada ja seda kogu Docsify, 100% tasuta ja avatud lähtekoodiga.