Создание документации с помощью файлов уценки с помощью Docsify

Если вы создаете бесплатный плагин, фреймворк или скрипт с открытым исходным кодом, вам потребуется документация. Крайне важно документировать свою работу как для вашего здравомыслия, так и для помощи другим, кто хочет освоить ваш удивительный ресурс.

Тем не менее, создание онлайн документации может быть реальной болью. К счастью, Docsify делает это проще, предоставляя бесплатный генератор документации, работающий на Markdown.

Это не типичный генератор статического сайта, и он не требует статических страниц HTML / CSS. Вместо этого он загружает файлы Markdown динамично и отображает их как веб-страницы. Довольно аккуратно!
Проверьте Домашняя страница Docsify для предварительного просмотра макета, а также дальнейшие подробности настройки.

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

Читайте также: 10 разработчиков привычек программирования должны принять

Весь процесс подробно изложен в Краткое руководство пользователятак что это, пожалуй, лучшее место для начала. Все это может выполняться через npm, так что это действительно помогает узнать вашу командную строку или, по крайней мере, быть готовым к обучению.

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

По мере изучения системы Docsify вы можете добавлять функции, используя Markdown или необработанный HTML. Эти функции включают настраиваемую панель навигации и даже вашу собственную титульную страницу с логотипом вашего проекта.

Docsify даже поставляется в комплекте с кучей бесплатных тем, если вы хотите работать с заранее разработанными макетами. Или вы можете просмотреть их галерею, чтобы увидеть, какие проекты используют Docsify для своей документации.
Все основные сведения о настройке и загрузки файлов можно найти на GitHubтак что идите туда, если хотите попробовать.

Вы также можете увидеть живую демонстрацию на главная страница документации Docsify который, конечно же, работает на Docsify. Итак, если вам нравится этот макет веб-страницы, вы можете использовать тот же шаблон и запустить его через Docsify, на 100% бесплатно и с открытым исходным кодом.

Читайте также: Как опубликовать страницу Github