一个github页面导入工具。
ghp-import2的Python项目详细描述
一个github页面导入工具。
警告
这将销毁您的gh-pages分支。如果你喜欢,你会想 在玩这个之前先备份。此脚本假定gh pages是 100%衍生产品。你不应该手工编辑网页中的文件 如果你使用这个脚本是因为你将失去你的工作。
安装
pip install ghp-import2
用法
Usage: ghp-import [OPTIONS] DIRECTORY
- Options:
-n Include a .nojekyll file in the branch. -m MESG The commit message to use on the target branch. -p Push the branch to origin/{branch} after committing. -r REMOTE The name of the remote to push to. [origin] -b BRANCH Name of the branch to write to. [gh-pages] -h, --help show this help message and exit
很简单。在存储库中运行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公共许可下分发。查看许可证 文件以获取更多信息。
变更日志
1.0.1(2016-01-23)
- 修复了python 3上的中断。克里斯·沃里克在#1中撰稿。
1.0.0(2015-05-09)
- pypi上的第一个版本。