GitHub Pages 是什么?
GitHub Pages是一項靜態(tài)網(wǎng)頁托管服務朋譬。
GitHub Pages可以直接從GitHub倉庫為你生成個人笨奠、企業(yè)或項目頁面。獲取更多關于不同類型的GitHub Pages站點信息淮蜈,請參考個人、企業(yè)和項目頁面
你可以使用Jekyll主題選擇器在線創(chuàng)建和發(fā)布GitHub Pages已卷。如果你喜歡在本地工作梧田,你可以使用桌面版本的GitHub或CMD命令行來發(fā)布頁面。
GitHub Pages是一項靜態(tài)網(wǎng)頁托管服務侧蘸,因此不支持PHP裁眯、Ruby或Python這樣的服務端代碼。
GitHub Pages 使用教程
在2016年6月15號之后創(chuàng)建的GitHub Pages 站點和使用github.io 域名的站點都需要使用HTTPS傳輸協(xié)議讳癌。如果你的站點在在2016年6月15號之前創(chuàng)建穿稳,你可以啟用HTTPS支持來分流你的站點。
GitHub Pages 不建議用來存放敏感內(nèi)容晌坤,如密碼或信用卡號
GitHub Pages 的使用服從GitHub的服務條款逢艘,包括禁止倒賣站點服務。
警告:即使存儲GitHub Pages站點的倉庫是私有的泡仗,這些站點也會在互聯(lián)網(wǎng)上公開訪問埋虹。如果你在你的頁面?zhèn)}庫里有敏感數(shù)據(jù)猜憎,你可以在發(fā)布之前刪除它娩怎。
使用限制
GitHub Pages 服從以下使用條款:
- GitHub Pages 源代碼庫有1GB的容量限制。
- 發(fā)布的GitHub Pages 站點大小不應該超過1GB胰柑。
- GitHub Pages 每月流量帶寬限制為100GB.
- GitHub Pages 站點每小時最多構建10次
如果你的站點超過了上述使用條款截亦,我們就會停止為你的站點服務或者你會收到一封來自GitHub支持中心的郵件爬泥,此郵件會給你策略來減少你的站點對我們的服務的影響,包括在你的站點上使用第三方CDN服務崩瓤,充分利用GitHub的其他功能袍啡,諸如發(fā)布或遷移到跟符合你的需求的其他主機服務。
除此之外却桶,GitHub Pages 包含以下內(nèi)容的站點會受到限制:
- 不合法的內(nèi)容或被我們的服務條款和社區(qū)指導所禁止的內(nèi)容或行為
- 包含暴力或恐嚇的內(nèi)容和行為
- 過量自動化的批量活動(如垃圾郵件)
- 對GiuHub用戶或服務妥協(xié)的行為
- 含有過度頻繁操作
- 含有性暗示的內(nèi)容
- 不代表你個人或網(wǎng)站觀點的內(nèi)容
如果你對你的使用或使用目的是否包含在這些目錄中有任何疑問境输,請與GitHub 支持中心聯(lián)系
配置一個可發(fā)布的GitHub Pages 源文件
你可以配置GitHub Pages 來發(fā)布你站點的源文件。項目頁面和其他符合特定要求的頁面的源文件可以放在master颖系、gh-pages嗅剖、或者是你的master分支下的/docs文件夾中。
如果你的站點是在被命名為<username>.github.io 或<orgname>.github.io 的倉庫中的個人或機構頁面嘁扼,那么你不能發(fā)布來自不同位置的站點源文件信粮。這種類型的個人倉庫名只能使用master分支來發(fā)布。
獲取更多關于不同類型的GitHub Pages 站點信息趁啸,請參考個人强缘、企業(yè)和項目頁面
為沒有命名空間的倉庫設置默認源
發(fā)布網(wǎng)站源文件的默認設置取決于你的網(wǎng)站類型和你的頁面?zhèn)}庫的分支。
如果你的頁面?zhèn)}庫沒有master 或gh-pages 分支不傅,你的GitHub 頁面發(fā)布源會被設置為None并且你的頁面不會被發(fā)布旅掂。
在你同時創(chuàng)建了master 和gh-pages 分支后,你可以設置一個分支作為你的發(fā)布源蛤签,之后你的頁面將會被發(fā)布辞友。
如果你fork 或者upload 的頁面?zhèn)}庫只包含一個master或者gh-pages分支,你的頁面源設置會自動為該分支啟用震肮。
為你來自master 或gh-pages 的分支啟用GitHub Pages
為了選擇master 或gh-pages 作為你的發(fā)布源称龙,你必須在你的倉庫里有一個當前分支。如果你沒有master 或gh-pages 分支戳晌,你可以創(chuàng)建他們?nèi)缓蠓祷氐皆丛O置來更改你的發(fā)布源鲫尊。
- 在GitHub 主頁,導航欄選擇你要設置的GitHub Pages 頁面的倉庫
- 在你選擇的倉庫頁面下沦偎,點擊Settings
- 在Settings 頁面疫向,向下滑動選擇master或gh-pages作為你的發(fā)布源
- 點擊Save
從master 分支下的/docs文件夾發(fā)布你的GitHub Pages頁面
為了發(fā)布你的master分支下的/doc文件夾下的頁面源文件,你必須有一個master分支和倉庫豪嚎。
- 在倉庫的根目錄有一個/docs文件夾
- 不按照<username>.github.io 或 <orgname>.github.io這樣的命名規(guī)則
為了發(fā)布你的頁面搔驼,GitHub Pages將會讀取你倉庫下的所有文件,包括/docs下的CNAME文件.比如侈询,當你通過GitHub Pages設置來編輯你自己的域名時舌涨,自定義域名將會寫入/docs/CNAME
tips:在/docs下的文件被使用后,如果你移除master分支下的/docs文件夾扔字,你的頁面將不會build并且你將會收到缺少/docs文件夾的頁面build錯誤信息囊嘉。
- 在GitHub主頁温技,導航欄選擇你要設置的GitHub Pages頁面的倉庫
- 在你的master分支的根目錄創(chuàng)建一個/docs文件夾
- 在你選擇的倉庫頁面下,點擊Settings
- 在Settings頁面扭粱,向下滑動選擇master或gh-pages作為你的發(fā)布源
- 點擊Save
個人舵鳞、企業(yè)和項目頁面
有兩種基本的GitHub Pages類型:個人/企業(yè)頁面和項目頁面。這兩種十分相似琢蛤,不過他們之間有幾個重大的差別蜓堕。
在2016年6月15日之后創(chuàng)建并且使用了github.io作為域名的GitHub Pages頁面將使用HTTPS傳輸協(xié)議.獲取更多相關信息,請參考的Securing your GitHub Pages site with HTTPS
tips:GitHub Pages不建議用來存放敏感數(shù)據(jù)博其,如密碼或信用卡號
記住俩滥,頁面是將會一直公開訪問即使他們的倉庫是私有的。
站點類型 | 頁面默認域名 | 建立頁面站點的源文件所在位置 |
---|---|---|
個人頁面 | username.github.io | master |
企業(yè)頁面 | orgname.github.io | master |
個人項目 | username.github.io/projectname | master, gh-pages, or a /docs folder on master |
企業(yè)項目 | orgname.github.io/projectname | master, gh-pages, or a /docs folder on master |
學習更多GitHub Pages 頁面重定向到個人域名的信息贺奠,請訪問custom domain redirects chart.
個人和企業(yè)頁面
個人和企業(yè)頁面需要專用的倉庫存放GitHub Pages文件霜旧。你需要用用戶名命名此倉庫
- 將倉庫命名為<username>.github.io
- master分支下的內(nèi)容將會被構建并發(fā)布到你的GitHub Pages 站點
你只能使用你自己的賬戶名作為個人或企業(yè)頁面的倉庫名。像joe/bob.github.io這樣的倉庫名將不會被build為一個個人頁面儡率。
當用戶頁面被構建后挂据,可以通過 http(s)://<username>.github.io 地址來訪問。
建立個人或企業(yè)頁面
個人頁面可以被任何已經(jīng)驗證過郵箱的賬戶所構建儿普。他們瞳影可以使用deploy-keys 來自動化完成處理崎逃。
企業(yè)頁面可以被任何push到倉庫的成員且已經(jīng)驗證過郵箱的賬戶所建立。為了自動建立眉孩,你可以搭建一個機器用戶作為企業(yè)的成員个绍。Deploy-keys 不支持企業(yè)頁面。
項目頁面
不像個人和企業(yè)頁面浪汪,項目頁面保存在項目的倉庫里巴柿。個人賬戶和企業(yè)賬戶都可以創(chuàng)建項目頁面。個人賬戶的項目頁面URL 是 “http(s)://<username>.github.io/<projectname>”死遭,企業(yè)的項目頁面URL 是“http(s)://<orgname>.github.io/<projectname>”广恢。這兩種賬戶創(chuàng)建項目頁面的步驟是一樣的。
項目頁面與個人/企業(yè)頁面十分相似呀潭,只有幾點不同:
- 你可以建立并發(fā)布來自master 或gh-pages 分支下的項目頁面站點钉迷。你也可以發(fā)布在master 分支下/docs文件夾里的站點。獲取更多信息钠署,請看Configuring a publishing source for GitHub Pages.
- 如果你沒有使用自定義域名糠聪,項目頁面站點會被運行在個人頁面的子目錄下:username.github.io/projectname
- 如果你的個人/企業(yè)站點使用了自定義域名,自定義的域名將會替代username.github.io 作為該賬戶項目頁面站點的URL谐鼎。使用了自定義域名的項目頁面站點同時也支持通過username.github.io/projectname (個人用戶),orgname.github.io/projectname (企業(yè)用戶)來訪問舰蟆。
- 自定義404頁面只能應用自定義域名的站點,否則用戶頁面404會被使用。
警告:如果你的頁面站點的URL包含了以破折號"-"為起止的用戶名或企業(yè)名夭苗,或者包含了連續(xù)的破折號"--",當Linux用戶訪問時會收到服務錯誤隔缀。為了避免此種情況题造,你的GitHub 用戶名應該刪除非字母表的字符。獲取更改用戶名指引請參考Changing your GitHub username