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

Question

我已经实现了一个Git命令，并使用git别名将其挂钩到Git中，但是有什么方法可以挂钩Git帮助吗？我正在Windows上运行，如果发出git help mycmd，则会弹出一个对话框，告诉我Git找不到git-mycmnd.html文件。

我已经使用Python实现了命令，所以除了“只知道”必须在何处放置帮助文件之外，是否有适当的方式添加帮助？

Answer 1

您可以为自己的别名定制文档，并且该文档可以本地保存或通过Web联机访问。运作方式如下：

首先：设置帮助格式

git config --local help.format html

第二：克隆官方的获取文档

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页面。

享受！