Структурирование страниц GitHub

Question

Если у вас есть сайт с именем http://username.github.com и проект с именем projectname, вы

1. используйте http://github.com/username/projectname/tree/gh-pages, чтобы а) отразить вашу основную ветку или б) создать веб-страницу, описывающую проект (для отражения в http://username.github.com/projectname), или
2. не имеет http://github.com/username/projectname/tree/gh-pages ветка вообще?

Answer 1

Что я понимаю о gh_pages, представленном в pages.github.com , так это о том, что:

• для создания отдельной ветви: вашаУ repo теперь есть два корня (один для master и все ветви dev, один для gh_pages для опубликованного контента GitHub).
  Корень для ветви gh_pages имеет специальную обработку при управлении GitHub.
• "публикация контентав Интернет ": и это может быть любой контент, который вы хотите.
  Так что, если вам не нужно полное пространство для документации, вы можете просто пойти с файлом readme.md или страницей index.html (" страница пользователя").
  help.github.com само организовано как документы в ветвях gh_pages .

Answer 2

У меня обычно вообще нет страницы проекта (большинство моих общедоступных проектов на github являются зеркалами других проектов с открытым исходным кодом), но на тех, где я их размещаю, у меня есть веб-страница, описывающая проект.

Хотя у меня только что возникла идея: возможно, было бы неплохо, чтобы ветка gh-pages проекта содержала выделенную версию вашего кода с гиперссылками (запустите ее через Doxygen и пусть он генерирует только перекрестные ссылки, а не документацию, например) ).