为别名命令添加“git help”？

Question

我已经实现了一个 Git 命令并使用 git 别名将其连接到 Git，但是有没有办法连接 Git 帮助？我在 Windows 上运行，如果我发出

git help mycmd

我会收到一个弹出窗口，告诉我 Git 找不到 git-mycmnd.html 文件。

我已经使用 Python 实现了我的命令，那么除了“只知道”帮助文件必须放置在哪里之外，是否有一种正确的 Git 风格的方式来添加帮助？

Answer 1

您可以为您的别名定制文档，该文档可以本地保存，也可以通过网络在线访问。其工作原理如下：

第一：设置帮助格式

git config --local help.format html

第二：clone官方获取文档

cd ~/Documents

git clone git://git.kernel.org/pub/scm/git/git-htmldocs.git git-doc

第三：添加一个简单的 HTML 页面，其中包含命令的文档

假设你的命令是

love

所以：

cd ~/Documents/git-doc
touch gitlove.html 
Add some text to the gitlove.html

第四：配置您的存储库以链接到文档存储库

cd YOUR_PROJECT_REPO
git config --local help.htmlpath ~/Documents/git-doc

现在您可以执行以下操作：

git help love

，您的 html 页面将会弹出。

享受吧！