Створити документацію з файлами 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% безкоштовний і з відкритим вихідним кодом.