Добавление 'git help' для псевдонимов

Question

Я реализовал команду Git и использовал псевдонимы git, чтобы подключить ее к Git, но есть ли способ подключить помощь Git?Я работаю в Windows, и если я выдаю git help mycmd, я получаю всплывающее окно, сообщающее, что Git не может найти файл git-mycmnd.html.

Я реализовал свою команду с помощью Python, поэтому естьправильный способ добавления справки, кроме «просто знания», где должны быть размещены файлы справки?

Answer 1

У вас может быть настроенная документация для ваших псевдонимов, и документация может быть либо сохранена локально, либо онлайн доступна через Интернет.Вот как это работает:

Первое: установить формат справки

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 страница появится.

Наслаждайтесь!