当我们想查询git某条指令如何使用时,git官网有详尽的文档供我们查看。在命令行下我们也可以随时通过 git –help的方法查看某条命令的详细帮助。
相对于在Terminal中内置的帮助文档,HTML格式更清晰,更详尽。
但是如果我想在无法上网的情况下也能查看git官网的详尽的帮助文档,有没有办法那?当然有了,下面就教大家如何在本机搭建git的HTML帮助文档。
在Windows上设置很简单,主需要安装Msysgit,就会自动为你设置起本地的HTML帮助文档。所以这篇文章主要讲在Mac和Linux下该如何实现。
一,运行git help –-web commit查看git默认的保存html文件的路径。
1 2 3 4 5 |
|
我们得到了git默认的存放html文件的路径是/usr/local/git/share/doc/git-doc
。当然你得到的路径有可能和这个不一样。
二,切换到这个路径下,迁出存放在git repo中的html文件。
1 2 3 4 |
|
三,运行 vim ~/.gitconfig 命令,在.gitconfig文件中加入如下配置。
1 2 3 4 5 6 7 |
|
当然也可以使用其他的编辑器来编辑.gitconfig文件。
只要这三步就设置起了本地的HTML帮助文档。你可以再次运行git help -–web commit
,就可以查看在浏览器中自动打开的HTML帮助说明页面了。
如果git的帮助文档更新了,如何同步到本地那?很简单,运行git pull
命令就行。
1 2 |
|
如何查看这些帮助文档那?更简单了,例如:
1 |
|
就会自动在浏览器中打开针对remote的帮助文档。
时间: 2024-10-27 05:49:02