# github

github 的使用笔记

# github pages

# 概述

github 提供 <username>.github.io 的域名,作为用户 github 仓库静态服务的地址. github page 存在两种类型.

• 用户或组织的主页

  • 仓库名必须为 <username>.github.io
  • 整个 master 分支下的内容用来编译生成你的主页
  • 仓库根目录,映射地址为 <username>.github.io/

• 用户或组织项目主页

  • master 或 gh-pages 整个分支编译生成项目主页
  • 只使用 master 下的 docs 文件夹作为项目主页
  • 项目根目录或 docs 目录,映射地址为 <username>.github.io/<projectname>/

路径映射原理参见 用户组织项目页面. 使用 github page 具有如下限制

• 资料内容不大于 1GB
• 流量限制 100GB/月
• 编译限制 10/小时

github 主页除了利用 html ,还可使用 Jekyll 来编译生成静态页面.

# github pages 快速配置

下面以用户 github pages 为例讲解配置步骤. 项目中的 github pages 类似.

1. 在 github 主页创建仓库名为 <username>.github.io 的项目

2. 在创建的项目的 Settings 选项 github pages 区域

   • 选择以 master branch 为主页 (默认纪委该选项)

3. 在仓库中中添加 index.html 文件内容为

<h1>hello world!</h1> 

4. 保存修改后,访问 http(s)://<username>.github.io/index.html 即可查看到内容.

可参考

• github pages 自定义
• github pages demo

# 使用 jekyll 编译原始内容

1. 忽略文件中添加 _site 文件夹作为本地浏览内容
2. 添加全局配置文件 _config.yml

参看 github pages 基本使用

# github Key already in use

解决方法

删除仓库中的公钥.在全局设置中添加即可.

# github api

1. 登录用户后,在 Settings/Developer settings personal access tokens 下生成 token.
2. 参考 api 进行调用

也可采用其他授权方式调用接口 授权调用

# 参考资料

• jekyll
• 域名重定向规则
• github.io 快速入门
• github.io 搭建
• github help
• config github page
• github pages