设置github上项目主页

在github上设置项目首页有三种方式

1.新建分支gh-pages

新建独立分支gh-pagesgit checkout --orphan gh-pages

删除暂存区内容
git rm -rf .

增加项目内容echo "project home page" > index.html

提交git add .git commit -m "gh-pages first commit"git push origin gh-pages

完成后即可访问 http://<github username>.github.io/<github project name>/

特点:

  • 单独建立一个分支与项目本身分离,对于非网站类项目非常合适,避免与源码之间的耦合
  • github会自动识别gh-pages分支作为项目pages的来源,无需设置
  • 单独管理文档,不予项目的提交放在一起

2.在master分支上

在master分支上增加index.html文件作为项目首页

在github项目下的settings里设置:在GitHub Pages 里选择master branch 点击save按钮

完成后即可访问 http://<github username>.github.io/<github project name>/

特点:

  • master分支即为项目pages,非常合适网站类项目,源码结构与线上网站结构相对应

3.在master的docs目录下

在master分支上docs目录下增加index.html文件作为项目首页

在github项目下的settings里设置:在GitHub Pages 里选择master branch/docs folder 点击save按钮

完成后即可访问 http://<github username>.github.io/<github project name>/

特点:

  • 单独使用一个目录与项目本身源码分离,适合希望文档管理与项目提交同时管理和更新的项目。
时间: 09-17

设置github上项目主页的相关文章

(转)花20分钟写的-大白话讲解如何给github上项目贡献代码

本文献给对git很迷茫的新手,注意是新手,但至少会点基本操作,有点基本概念的新手,我不会从怎么用github和git是什么开始讲的.如果作为新手你看书又看不进去,原理又太复杂,有没有直接了当告诉我们怎么给项目贡献代码,并和项目同步代码的大体流程.于是我快速写了这么个东西.一来整理下自己混乱的思路,二来想号召大家一起用git开发点东西,可是好几个同鞋只会寂寞的给自己push. 我先说下 我之前对github操作的一些迷茫历程,然后之后是怎么解惑的. 1. 最最开始,我以为git clone [项目

如何删除github上项目的文件

1. 你要有前面一章的开发平台和github插件,下面就是基于前面来做的. 如何删掉你github上的文件呢?想必你的电脑有一个下载的git工具了,如果还是没有的话,请用npm下载一个git.这是我已经下载好的. 2. 然后打开这个git,登录到你已经注册好的git上,如果没有注册马上去注册一个吧. 3. 看到左边有一个“+”的按钮,点开来看到你的项目文件和储存路径,然后你点击“clone”选项,可以看到你建立的项目.这是我已经建立好的3个分支项目. 4,然后你找到你要删掉的分支名称,点击你的分

github上项目的目录结构说明

build 构建脚本 dist 编译出来的发布版 docs 文档 examples 示例文件 src 源码 test 测试脚本 .babelrc Babel 交叉编译的配置 .eslintrc ESLint 测试配置 .gitignore 哪些文件不要上传到 GitHub .gitattributes 文件属性,如 EOL.是否为二进制等 LICENSE 授权协议 README.md 自述文件,里面至少得写: 项目的特色 各种 Badge 比如 CI 的 怎么下载安装 示例运行/使用 怎么编译(

一步步在github上搭建自己的主页以及绑定域名

我们如果想要一个属于自己的网站,都需要买域名和服务器,然而,这些都需要人民币.下面我来和大家分享一个小技巧,来免费创建自己的网站. 在github上搭建起来自己的主页下面我们一起来看一下如何搭建. 在github上放自己的网页 (一) 首先自己要有一个github账号,那么去注册一个:https://github.com/join?source=login ,注册好了之后,我们进入github .比如以前我注册的名称是 johnnynode . (二) 然后点击右上角的 "+"号 ,我

【转载】【技巧总结】PyCharm怎么克隆github上开源的项目

PyCharm怎么clone github上开源的项目 一.先要确保PyCharm正确的配置了Git ??如果你已经在PyCharm中配置好了Git,可以跳过此步骤,直接看下一步. ??那么怎么在PyCharm中配置Git呢? 百度搜索Git安装包,安装过程不再多说,请记住Git的安装路径: 打开PyCharm,如图1-1所示:  图1-1 点击右下角的"Configure",如图1-2所示:  图1-2 点击"Settings", 出现如图1-3所示界面:  图1

git的使用,将本地项目push到github上

git是先用add 把代码添加到缓冲区,然后commit提交到本地,等到需要时,再用push到远程服务器文章:http://blog.csdn.net/j_bing/article/details/44754775, http://www.ruanyifeng.com/blog/2014/06/git_remote.html先在GitHub上建立一个代码仓库,第一种方式:在电脑上建立一个文件夹,然后在该文件夹下打开git bash,输入git init:表示把git仓库放在这里,然后git cl

在Github上搭建自己的博客(Windows平台)

折腾了好久,终于在Github上搭建了自己的博客.这里面总结一下过程希望对大家能有所帮助. Github建博优缺点 和 csdn,新浪,网易相比,在Github上可以自己实现功能 和阿里云,VPS相比,github托管的代码是免费的 github上只能托管静态网页,后台有数据库的这种动态网站不能托管 你有一个Github的账号 懂一些基本的Web开发相关的知识 Ruby运行时,可以在Windows或者linux环境下进行安装 建站的过程 在github创建网站的代码库,名字必须为username

把自己github上的代码添加cocoapods支持

一.前言 这两天被cocoapods折磨的心力憔悴.看cocoapods官网的添加支持,但是介绍的(ying)比(yu)较(tai)简(cha)单,而且有的步骤也没有写上,导致看着官方文档也没有成功,后来查阅了简书.CocoaChina等等,还是已经接近崩溃.没有一个完整的介绍.索性多个文档对比测试,最后终于成功的让自己Github上的库成功支持Cocoapods安装. 二.开始 这里我将从最初的开始进行介绍,包括Github上创建项目已经上传项目,到最后的支持Cocoapods. 步骤如下:

解决Github下载项目慢的问题

一个痛点众所周知,GitHub 是一个巨大的开源宝库,以及程序员和编程爱好者的聚集地,包括我之前推荐的诸多优秀的开源项目全部都是位于 GitHub 上.但是每当我们看到优秀的开源项目,准备去下(bai)载(piao)时,会发现 git clone的速度异常之慢!就我个人而言,在我家里 200M 移动宽带的环境下,我克隆开源项目就没发现速度大于过 20.00KiB/s的时候,这简直太难受了. 小项目倒还好,我等几分钟无所谓:一旦项目庞大起来,或者项目文件数目一多, git clone 大概率会失败