構建GitHub的頁面

Question

如果你有一個名爲http://username.github.com網站和一個叫projectname項目，你

1. 使用http://github.com/username/projectname/tree/gh-pages到）鏡像您的主分支，或者b）創建描述項目的網頁（被反射在http://username.github.com/projectname）或
2. 根本沒有http://github.com/username/projectname/tree/gh-pages 分支？

Answer 1

我明白gh_pages的作爲pages.github.com提出，就在於它是：

• 創建一個單獨的分支：你的回購現在已經兩個根（一個用於主機和所有的開發分支，一個爲GhHub發佈內容的gh_pages）。
  gh_pages分支的根由GitHub管理時有特殊待遇。
• 「將內容發佈到網絡上」：並且可以是您想要的任何內容。
  因此，如果您不需要文檔的完整空間，則可以使用readme.md文件或index.html頁面（「用戶頁面」）。
  help.github.com本身組織爲documents within a gh_pages branches。

Answer 2

我通常沒有項目頁面（我的大多數公共github項目都是其他開源項目的鏡像），但在我所做的項目中，我有一個描述項目的網頁。

雖然我只是有一個想法：可能是整潔，使項目的GH-頁面分支包含高亮，超鏈接代碼（通過使用Doxygen運行的版本，並將它只能產生交叉引用的來源，而不是文檔中，例）。