truezemez Dec 30 2013 at 14:58

Github + Markdown = Viewdocs

1 min

14K

Website development*Open source*

Translation

+18

Comments 15

Mithgol Dec 30 2013 at 16:23

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

lolmaus Dec 30 2013 at 17:09

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

chib Jan 1 2014 at 11:47

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

HomoLuden Dec 30 2013 at 17:53

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

truezemez Dec 30 2013 at 18:04

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

HomoLuden Dec 30 2013 at 18:11

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

gro Dec 30 2013 at 18:07

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

zencd Dec 30 2013 at 18:41

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

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

truezemez Dec 30 2013 at 18:47

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

truezemez Dec 30 2013 at 18:49

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

truezemez Dec 30 2013 at 18:54

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

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

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

zencd Dec 30 2013 at 19:42

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

lolmaus Dec 31 2013 at 03:59

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

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

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

plutov Sep 4 2014 at 21:25

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

asheee Sep 8 2014 at 10:49

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

Show the best of all time