ghp-import2 1.0.1

警告

这将销毁您的gh-pages分支。如果您喜欢它，您在玩之前需要备份。此脚本假定gh-pages是100%派生的。如果您使用此脚本，则不应手动编辑gh-pages分支中的文件，否则您将丢失您的作品。

安装

pip install ghp-import2

用法

用法：ghp-import [OPTIONS] DIRECTORY

选项

-n

在分支中包含一个.nojekyll文件。

-m MESG

要在目标分支上使用的提交消息。

-p

提交后推送分支到origin/{branch}。

-r REMOTE

要推送到的远程名称。[origin]

-b BRANCH

要写入的分支名称。[gh-pages]

-h，--help

显示此帮助信息并退出

很简单。只需在您的仓库中运行 ghp-import $DOCS_DIR 即可，其中 $DOCS_DIR 是生成的文档的路径。这将向您的 gh-pages 分支添加一个提交，其中包含当前文档。

如果您指定 -p，它还会尝试将 gh-pages 分支推送到 GitHub。默认情况下，它将运行 git push origin gh-pages。您可以使用 -r 标志指定不同的远程仓库。

您可以使用 -b 指定不同的分支。这对于用户和组织页面很有用，这些页面是从 master 分支提供的。

ghp-import 也能识别 GIT_DIR 环境变量，这对于 Git 钩子可能很有用。

许可证

ghp-import 在 Tumbolia 公共许可证下分发。有关更多信息，请参阅 LICENSE 文件。

1.0.1 (2016-01-23)

• 修复了 Python 3 上的中断问题。由 Chris Warrick 在 #1 贡献。

1.0.0 (2015-05-09)

• 在 PyPI 上首次发布。