gulp-gh-pages

一个用于将内容发布到Github页面的gulp插件。

安装

使用npm的安装命令：

npm install --save-dev gulp@next gulp-gh-pages

使用

在你的gulpfile.js中定义一个名为deploy的任务（如下所示），该任务可用来推送到gh-pages分支。

const { src, task } = require('gulp');
const ghPages = require('gulp-gh-pages');

task('deploy', () => src('./dist/**/*').pipe(ghPages()));

现在，你可以通过以下命令执行此任务：

gulp deploy

API

const ghPages = require('gulp-gh-pages');

ghPages([options])

options: 对象
返回: [stream.Transform](https://nodejs.org/api/stream.html#stream_class_stream_transform)

options.remoteUrl

类型: 字符串
默认: 当前目录的远程仓库URL（假设是一个git仓库）

默认情况下，gulp-gh-pages假定当前工作目录是一个git仓库，并使用标记为origin的远程URL。如果你的gulpfile.js不在git仓库内，或者你想推送到其他远程URL，可以指定它。确保你对目标仓库拥有写权限。

options.branch

类型: 字符串
默认: "gh-pages"

部署将在此分支上执行。对于username.github.io项目，应改为"master"。

options.cacheDir

类型: 字符串
默认: .publish

设置缓存仓库路径，以保存仓库的一个副本。如果该目录不存在，gulp-gh-pages会自动创建它。

options.push

类型: 布尔值
默认: true

允许你在不将其推送到主分支的情况下，在定义的分支上构建。这对于预演很有用。

options.force

类型: 布尔值
默认: false

强制将文件添加到gh-pages分支，即使它们被.gitignore或.gitignore_global忽略。

options.message

类型: 字符串
默认: "更新 [时间戳]"

自定义提交信息。

许可证

MIT许可证 © 2014 Micheal Benedict, 2015 - 2018 Shinnosuke Watanabe