páginas GitHub Estructuración

Question

Si usted tiene un sitio llamado http://username.github.com y un proyecto llamado projectname, lo hace

1. uso http://github.com/username/projectname/tree/gh-pages a a) reflejar su rama principal, o b) crear una página web que describe el proyecto (que se refleja en http://username.github.com/projectname) o
2. no tienen una rama http://github.com/username/projectname/tree/gh-pages en absoluto?

Answer 1

Lo que entiendo de gh_pages como se presenta en pages.github.com, es que es para:

• la creación de una rama separada: tu repositorio tiene ahora dos raíces (una para maestro y todos las ramas dev, uno para gh_pages para el contenido publicado de GitHub).
  La raíz de la rama gh_pages tiene un tratamiento especial cuando es administrado por GitHub.
• "publicar contenido en la web": ese puede ser el contenido que desee.
  Así que si no necesita un espacio completo para documentaciones, puede ir con un archivo readme.md o una página index.html ("página de usuario").
  help.github.com está organizado como documents within a gh_pages branches.

Answer 2

Por lo general no tienen una página del proyecto en absoluto (la mayoría de mis proyectos de GitHub públicas son espejos de otros proyectos de código abierto), pero en aquellos en los que hago, tengo una página web que describe el proyecto .

Aunque acabo de tener una idea: podría ser útil hacer que una rama de gh-páginas del proyecto contenga una versión destacada de su código hipervinculado (ejecutarlo a través de Doxygen y generar solo referencias cruzadas en lugar de documentación, ejemplo).