Github + Markdown = Viewdocs

[Mithgol]

Очень полезное средство, спасибо за перевод.

[lolmaus]

Без панельки навигации по документации это ненамного лучше просмотра README-файлов прямо в Github.

[chib]

Если вы переросли гитхабовский readme, то можете попробовать использовать backdoc. Генерируется полностью самостоятельный one-page-doc с навигацией и inline cтилями из простого маркдауна.

[HomoLuden]

А связка Github Pages + Angular JS + Markdown.js (или альтернативы последних двух) не работает разьве?

[truezemez]

Автору в Github Pages не нравится использование отдельного бранча.

[HomoLuden]

Хммм Ну не знаю… Я пока не начал активно использовать, но мне кажется это не критично. Бранч меняется в два-три клика с помощью гитхабовского клиента. Ну или можно перманентно зачекаутить нужный бранч в отдельную папку.

[gro]

А Github Wiki чем автору не маркдаун?

[zencd]

Просто следуйте соглашениям — каким соглашениям? Где хостится документация? Как инициируется её регенерация?

Больше таких переводов! Так больше людей выучат английский.

[truezemez]

1. В репозитории Вашего проекта создаете папку docs
2. Кладете в нее index.md.
3. Заходите на http://<github-username>.viewdocs.io/<repository-name>
4. Видите содержимое Вашего index.md (генерация происходит на лету)

[truezemez]

Пример:
При заходе на progrium.viewdocs.io/viewdocs
Вы увидите содержимое github.com/progrium/viewdocs/blob/master/docs/index.md

[truezemez]

Больше таких переводов! Так больше людей выучат английский.

Вы считаете, что в оригинальной статье тема раскрыта более полно?

Эта статья подразумевает, что Вы как минимум сталкивались с этими сервисами:
gist.io
pages.github.com
readthedocs.org

[zencd]

Конечно тема не раскрыта! Именно поэтому и не имеет смысла «переводить» подобное в оригинальном виде.

[lolmaus]

В копилку аналогичных сервисов:

— www.roughdraft.io/
— gist.io/

Работают на базе gist.github.com/, то есть им даже репозиторий не нужен.

[plutov]

А вот и документация вышла по Markdown: plutov.by/post/markdown_docs.

[asheee]

Не успели: «This domain was disabled at the request of John Gruber». :D