Генериране на документация с Markdown файлове, използващи Docsify

Ако създавате безплатен плъгин, рамка или скрипт с отворен код ще се нуждаете от документация. Това е от решаващо значение документирайте работата си, както за вашия здрав разум, така и за подпомагане на другите, които искат да научат вашия страхотен ресурс.

Въпреки това, създаването на онлайн документация може да бъде истинска болка. благодарно, Docsify улеснява предоставянето на безплатен генератор на документация, работещ на Markdown.

Това е не е типичен статичен генератор на сайтове и го прави не изискват статични HTML / CSS страници. Вместо това зарежда Markdown файлове динамично и ги показва като уеб страници. Доста чиста!

Вижте началната страница на Docsify за a Визуализация на оформлението, заедно с допълнителни подробности за настройката.

Това изисква от вас създайте сами index.html файла, които след това могат да бъдат качени на GitHub Pages или да се хостват на вашия собствен сървър. От там, ти просто напишете Markdown файлове за всяка страница и ги използвайте като основни документи.

Целият процес е подробно описан в ръководство за бърз старт, така че това е може би най-доброто място за започване. Това може всички преминават през npm, така че наистина помага да знаете командния ред или поне да сте готови да научите.

Възможно е сами да създадете суров HTML файл и просто копирайте / поставете шаблона от ръководството за настройка на Docsify. Но, препоръчвам ви правим това динамично, тъй като спестява много време - и не е ли наистина въпросът?

Когато научите системата Docsify, можете добавете функции, като използвате Markdown или суров HTML. Тези функции включват: a персонализирана лента за навигация и дори Вашата собствена титулна страница с логото на вашия проект.

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

Всички основна информация за настройка и изтегляне на файлове може да се намери на GitHub, така че се отправете там, ако искате да дадете този изстрел.

Можете също вижте демонстрация на живо на главната страница на документацията за Docsify което, разбира се, работи на Docsify. Така че, ако ви харесва това оформление на уеб страница, можете да използвате същия шаблон и да го изпълните чрез Docsify, 100% безплатно и с отворен код.