Skip to main content

一个 GitHub Pages 导入工具。

项目描述

一个 GitHub Pages 导入工具。

警告

这将破坏您的gh-pages分支。如果你喜欢它,你会想要在玩这个之前进行备份。此脚本假定gh-pages是 100% 衍生的。如果你使用这个脚本,你永远不应该手动编辑你的gh-pages分支中的文件,因为你会丢失你的工作。

安装

pip install ghp-import2

用法

用法: ghp-import [OPTIONS] 目录

选项:
-n

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

-m MESG

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

-p

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

-r REMOTE

要推送到的遥控器的名称。[起源]

-b BRANCH

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

-h, --help

显示此帮助信息并退出

它很简单。在您的存储库中,只需运行ghp-import $DOCS_DIR 其中$DOCS_DIR构建文档的路径。这将向您的gh-pages分支写入一个提交,其中包含当前文档。

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

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

ghp-import还可以识别GIT_DIR环境变量,这对 Git 挂钩很有用。

执照

ghp-import是根据 Tumbolia 公共许可证分发的。有关详细信息,请参阅许可证文件。

变更日志

1.0.1 (2016-01-23)

  • 修复了 Python 3 的损坏问题。由 Chris Warrick 在#1中提供。

1.0.0 (2015-05-09)

  • PyPI 上的第一个版本。

下载文件

下载适用于您平台的文件。如果您不确定要选择哪个,请了解有关安装包的更多信息。

源分布

ghp-import2-1.0.1.tar.gz (13.2 kB 查看哈希

已上传 source

内置分布

ghp_import2-1.0.1-py2.py3-none-any.whl (7.3 kB 查看哈希

已上传 py2 py3