Документация очень важна для программного обеспечения с открытым исходным кодом.
По своему опыту я обнаружил, что написание хорошей документации зачастую даже важнее, чем написание тестов.
Когда я перерос README на Github, я рассматривал только 2 варианта документации: Страницы Гитхаба И Прочтите документацию .
К сожалению, у меня были проблемы с обоими.
В основном Read the Docs заставляет меня использовать реструктурированный текст, а Github Pages вынуждает меня поддерживать отдельную ветку и использовать генератор статических страниц.
На самом деле, я хотел бы иметь что-то похожее на Gist.io , только для моего репозитория.
Не найдя ничего подходящего, написал сам.
Я называю это Просмотр документов .
Сервис создает страницы из уценки на лету в папке документации вашего проекта.
Установка не требуется, просто следуйте соглашениям.
Возможно, это уже работает для вас, потому что.
уценка в папке docs не такая уж редкость.
Шаблон по умолчанию был позаимствован у Gist.io. Дополнительную информацию можно найти на веб-сайте Viewdocs, созданном на базе Viewdocs. Или вот краткий вводный скриншот: Теги: #Markdown #документация #github #разработка веб-сайтов #открытый исходный код
-
Анализ Hp Probook 4510S-Vc313Ea
19 Oct, 24 -
Интервью С Победителями Конкурса На Techdays
19 Oct, 24 -
Вконтакте.ру Csrf
19 Oct, 24
