Генеришите документацију помоћу Маркдовн датотека помоћу Доцсифи

Ако креирате бесплатан додатак, оквир или скрипту отвореног кода требат ће вам документација. То је кључно за документујте свој рад, и за ваш здрав разум и за помоћ другима који желе да науче ваш страшан ресурс.

Међутим, креирање онлине документације може бити прави бол. Срећом, Доцсифи олакшава давање бесплатни генератор документације који ради на Маркдовн-у.

Ово је није типичан статички генератор локације и јесте не захтевају статичне ХТМЛ / ЦСС странице. Уместо тога учитава Маркдовн датотеке динамички и приказује их као веб странице. Привлачна!

Погледајте почетну страницу Доцсифи за а преглед изгледа, упоредо са додатне детаље о подешавању.

То захтева да ви сами креирајте индек.хтмл фајл, који се затим могу учитати на ГитХуб странице или хостовати на вашем властитом серверу. Одатле, ви само напишите Маркдовн датотеке за сваку страницу и користите их као примарне документе.

Цео процес је детаљно описан у брзи водич, тако да је то вероватно најбоље место за почетак. Ово може све тече кроз нпм, тако да стварно помаже да знате вашу командну линију или бар желите да научите.

Могуће је сами креирати необрађену ХТМЛ датотеку и једноставно копирати / залијепити предложак из водича за постављање програма Доцсифи. Али, препоручујем то радимо динамично, јер штеди тона времена - и није ли то уистину поента?

Док учите систем Доцсифи, можете додајте функције помоћу Маркдовн-а или сировог ХТМЛ-а. Ове функције укључују: а прилагођена навигацијска трака и чак своју насловну страницу са логом вашег пројекта.

Доцсифи евен долази са гомилом бесплатних тема ако желите унапријед дизајниране распореде за рад. Или, можете прегледајте њихову галерију изложби да види који пројекти користе документацију за своју документацију.

Све основне информације о инсталацији и преузимању датотека може се наћи на ГитХубу, па идите тамо ако желите да дате овај снимак.

Можете такође погледајте демо уживо на главној страници документације Документи који, наравно, ради на документацији. Дакле, ако вам се свиђа тај изглед веб странице можете користити исти предложак и покренути га кроз документе, 100% бесплатно и отвореног кода.