ghp-import项目技术文档

1. 安装指南

ghp-import 是一个Python脚本，用于将生成的文档直接推送到GitHub Pages。安装ghp-import非常简单，您可以通过以下命令进行安装：

pip install ghp-import

确保您的Python环境已安装并配置好pip。

2. 项目的使用说明

ghp-import 的主要目的是将文档文件夹内容导入到GitHub的gh-pages分支，以下是基本使用方法：

ghp-import [OPTIONS] DIRECTORY

其中DIRECTORY是包含已构建文档的目录路径。该命令将创建一个commit，将这些文档放入gh-pages分支。

以下是可用的选项：

• -n, --no-jekyll: 在分支中包含一个.nojekyll文件。
• -c CNAME, --cname=CNAME: 在分支中写入一个带有给定CNAME的CNAME文件。
• -m MESG, --message=MESG: 在目标分支上使用的提交消息。
• -p, --push: 提交后推送分支到远程。
• -x PREFIX, --prefix=PREFIX: 推送到远程的每个文件要添加的前缀。
• -f, --force: 强制推送至仓库。
• -o, --no-history: 强制不使用父历史记录的新commit。
• -r REMOTE, --remote=REMOTE: 要推送的远程名称，默认为origin。
• -b BRANCH, --branch=BRANCH: 写入的分支名称，默认为gh-pages。
• -s, --shell: 调用Git时使用shell。
• -l, --follow-links: 添加文件时跟随符号链接。

对于Windows用户，如果需要通过shell传递Git命令，可以使用-s选项。

3. 项目API使用文档

ghp-import 也可以作为Python库直接在您的代码中使用。可以通过以下方式调用：

from ghp_import import ghp_import

ghp_import(
    srcdir='docs',        # 已构建的文档所在路径
    push=True,            # 提交后是否推送
    cname='example.com',  # CNAME文件内容
    # 其他可选参数
)

请确保在调用此函数时，当前工作目录是您的Git仓库目录。

4. 项目安装方式

除了通过pip安装ghp-import之外，如果您需要手动安装或修改源代码，可以克隆项目到本地：

git clone https://github.com/davisp/ghp-import.git

然后，进入项目目录并运行安装脚本：

cd ghp-import
python setup.py install

确保在安装前您的系统中已安装了必要的Python开发工具和pip。