Comments 15
Очень полезное средство, спасибо за перевод.
Без панельки навигации по документации это ненамного лучше просмотра README-файлов прямо в Github.
Если вы переросли гитхабовский readme, то можете попробовать использовать backdoc. Генерируется полностью самостоятельный one-page-doc с навигацией и inline cтилями из простого маркдауна.
А связка Github Pages + Angular JS + Markdown.js (или альтернативы последних двух) не работает разьве?
А Github Wiki чем автору не маркдаун?
Просто следуйте соглашениям — каким соглашениям? Где хостится документация? Как инициируется её регенерация?
Больше таких переводов! Так больше людей выучат английский.
Больше таких переводов! Так больше людей выучат английский.
1. В репозитории Вашего проекта создаете папку
2. Кладете в нее
3. Заходите на
4. Видите содержимое Вашего
docs2. Кладете в нее
index.md.3. Заходите на
http://<github-username>.viewdocs.io/<repository-name>4. Видите содержимое Вашего
index.md (генерация происходит на лету)Пример:
При заходе на progrium.viewdocs.io/viewdocs
Вы увидите содержимое github.com/progrium/viewdocs/blob/master/docs/index.md
При заходе на progrium.viewdocs.io/viewdocs
Вы увидите содержимое github.com/progrium/viewdocs/blob/master/docs/index.md
Больше таких переводов! Так больше людей выучат английский.
Вы считаете, что в оригинальной статье тема раскрыта более полно?
Эта статья подразумевает, что Вы как минимум сталкивались с этими сервисами:
gist.io
pages.github.com
readthedocs.org
В копилку аналогичных сервисов:
— www.roughdraft.io/
— gist.io/
Работают на базе gist.github.com/, то есть им даже репозиторий не нужен.
— www.roughdraft.io/
— gist.io/
Работают на базе gist.github.com/, то есть им даже репозиторий не нужен.
А вот и документация вышла по Markdown: plutov.by/post/markdown_docs.
Sign up to leave a comment.
Github + Markdown = Viewdocs