utils-code/tj.git-extras
1
0
Fork 0
mirror of https://github.com/tj/git-extras.git synced 2026-09-10 07:26:17 -04:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
tj.git-extras/man
History
nickl- b7fe4c123a The complete index of all available documents.
2012-07-22 22:27:37 +02:00
..
git-alias.1 documentation for git-alias 2011-03-16 15:58:27 -03:00
git-alias.1.html documentation for git-alias 2011-03-16 15:58:27 -03:00
git-alias.md documentation for git-alias 2011-03-16 15:58:27 -03:00
git-back.md new git-back command for soft undos 2011-06-17 09:01:39 -04:00
git-bug.md Adding bug/refactor/feature man pages 2012-06-26 11:04:30 +02:00
git-changelog.1 Built docs 2010-10-31 11:51:12 -07:00
git-changelog.html Added html docs 2010-10-31 11:51:24 -07:00
git-changelog.md Renamed man pages to *.md 2010-10-31 11:41:30 -07:00
git-commits-since.1 Added examples to git-commits-since 2012-07-22 22:27:37 +02:00
git-commits-since.html Added examples to git-commits-since 2012-07-22 22:27:37 +02:00
git-commits-since.md Added examples to git-commits-since 2012-07-22 22:27:37 +02:00
git-contrib.1 Built docs 2010-10-31 11:51:12 -07:00
git-contrib.html Added html docs 2010-10-31 11:51:24 -07:00
git-contrib.md Renamed man pages to *.md 2010-10-31 11:41:30 -07:00
git-count.1 Built docs 2010-10-31 11:51:12 -07:00
git-count.html Added html docs 2010-10-31 11:51:24 -07:00
git-count.md Renamed man pages to *.md 2010-10-31 11:41:30 -07:00
git-create-branch.1 Added git-create-branch 2011-02-22 17:04:44 -03:00
git-create-branch.1.html Added git-create-branch 2011-02-22 17:04:44 -03:00
git-create-branch.md Added git-create-branch 2011-02-22 17:04:44 -03:00
git-delete-branch.1 Built docs 2010-10-31 11:51:12 -07:00
git-delete-branch.html Added html docs 2010-10-31 11:51:24 -07:00
git-delete-branch.md Renamed man pages to *.md 2010-10-31 11:41:30 -07:00
git-delete-merged-branches.md Adding delete-merge-branches, gh-pages, rename-tag and squash manpages 2012-06-28 21:14:17 +02:00
git-delete-submodule.1 Built docs 2010-10-31 11:51:12 -07:00
git-delete-submodule.html Added html docs 2010-10-31 11:51:24 -07:00
git-delete-submodule.md Renamed man pages to *.md 2010-10-31 11:41:30 -07:00
git-delete-tag.1 Built docs 2010-10-31 11:51:12 -07:00
git-delete-tag.html Added html docs 2010-10-31 11:51:24 -07:00
git-delete-tag.md Renamed man pages to *.md 2010-10-31 11:41:30 -07:00
git-effort.1 Added missing documenation for git-effort command 2012-06-12 16:45:34 -04:00
git-effort.html Added missing documenation for git-effort command 2012-06-12 16:45:34 -04:00
git-effort.md Added missing documenation for git-effort command 2012-06-12 16:45:34 -04:00
git-extras.1 The complete index of all available documents. 2012-07-22 22:27:37 +02:00
git-extras.html The complete index of all available documents. 2012-07-22 22:27:37 +02:00
git-extras.md The complete index of all available documents. 2012-07-22 22:27:37 +02:00
git-feature.md Adding bug/refactor/feature man pages 2012-06-26 11:04:30 +02:00
git-fresh-branch.1 Update man/git-fresh-branch.1 2012-02-04 13:22:00 -05:00
git-fresh-branch.html Update man/git-fresh-branch.html 2012-02-04 13:22:38 -05:00
git-fresh-branch.md Update man/git-fresh-branch.md 2012-02-04 13:18:42 -05:00
git-gh-pages.md Adding delete-merge-branches, gh-pages, rename-tag and squash manpages 2012-06-28 21:14:17 +02:00
git-graft.1 Added git-extras, removed git-extras-version and git-extras-update 2011-03-27 09:01:40 -07:00
git-graft.html Added git-extras, removed git-extras-version and git-extras-update 2011-03-27 09:01:40 -07:00
git-graft.md git-graft now defaults to current branch instead of master 2011-04-05 13:20:25 -07:00
git-ignore.1 Complete git-ignore includes global. 2012-07-22 22:27:37 +02:00
git-ignore.html Complete git-ignore includes global. 2012-07-22 22:27:37 +02:00
git-ignore.md Complete git-ignore includes global. 2012-07-22 22:27:37 +02:00
git-info.1 whitespace only 2012-07-22 22:27:37 +02:00
git-info.html whitespace only 2012-07-22 22:27:37 +02:00
git-info.md whitespace only 2012-07-22 22:27:37 +02:00
git-local-commits.1 Added git-local-commits: script to show a log of all commits not pushed to origin 2012-03-31 16:15:00 -07:00
git-local-commits.html Added git-local-commits: script to show a log of all commits not pushed to origin 2012-03-31 16:15:00 -07:00
git-local-commits.md Added git-local-commits: script to show a log of all commits not pushed to origin 2012-03-31 16:15:00 -07:00
git-refactor.md Adding bug/refactor/feature man pages 2012-06-26 11:04:30 +02:00
git-release.1 Built docs 2010-10-31 11:51:12 -07:00
git-release.html Added html docs 2010-10-31 11:51:24 -07:00
git-release.md Renamed man pages to *.md 2010-10-31 11:41:30 -07:00
git-rename-tag.md Adding delete-merge-branches, gh-pages, rename-tag and squash manpages 2012-06-28 21:14:17 +02:00
git-repl.1 Built docs 2010-10-31 11:51:12 -07:00
git-repl.html Added html docs 2010-10-31 11:51:24 -07:00
git-repl.md Renamed man pages to *.md 2010-10-31 11:41:30 -07:00
git-setup.1 Built docs 2010-10-31 11:51:12 -07:00
git-setup.html Added html docs 2010-10-31 11:51:24 -07:00
git-setup.md Renamed man pages to *.md 2010-10-31 11:41:30 -07:00
git-show-tree.1 Added git-show-tree. 2012-07-22 22:27:37 +02:00
git-show-tree.html Added git-show-tree. 2012-07-22 22:27:37 +02:00
git-show-tree.md Added git-show-tree. 2012-07-22 22:27:37 +02:00
git-squash.md Adding delete-merge-branches, gh-pages, rename-tag and squash manpages 2012-06-28 21:14:17 +02:00
git-summary.1 Updating git-summary documentation, because we added a 'repo age' field to git-summary command. 2012-06-12 14:12:06 -04:00
git-summary.html Updating git-summary documentation, because we added a 'repo age' field to git-summary command. 2012-06-12 14:12:06 -04:00
git-summary.md Updating git-summary documentation, because we added a 'repo age' field to git-summary command. 2012-06-12 14:12:06 -04:00
git-touch.1 Built docs 2010-10-31 11:51:12 -07:00
git-touch.html Added html docs 2010-10-31 11:51:24 -07:00
git-touch.md Renamed man pages to *.md 2010-10-31 11:41:30 -07:00
git-undo.1 git-undo now includes -h|--hard option. 2012-07-22 22:27:37 +02:00
git-undo.html git-undo now includes -h|--hard option. 2012-07-22 22:27:37 +02:00
git-undo.md git-undo now includes -h|--hard option. 2012-07-22 22:27:37 +02:00
index.txt The complete index of all available documents. 2012-07-22 22:27:37 +02:00
man-template.md Renamed man pages to *.md 2010-10-31 11:41:30 -07:00
manning-up.sh Added automated manual generation. 2012-07-22 22:27:37 +02:00
Readme.md Added automated manual generation. 2012-07-22 22:27:37 +02:00

Readme.md

How to generate documentation:

DESCRIPTION

To generate documentation:

  1. Start by filling out the 'man-template.md'

  2. Then use a program ronn. Get ronn from github.

  3. Run ronn:

    $ronn <filename>.md

  4. Remember, we use the following naming convention for files: git-<command>.html git-<command>.1 git-<command>.md

    You'll need to rename the html file, as ronn probably inserted a 1 into the filename.

EXAMPLE

$ ronn git-effort.md

roff: ./git-effort.1
html: ./git-effort.1.html                +man

$mv git-effort.1.html git-effort.html

SHELL SCRIPT

Alternatively you can run the manning-up.sh automated shell script included in the man folder. The script will recreate the git-extras index based on the list of .md files available before it runs ronn against each one to generate the documents as well as renaming the generated .html files to their desired form.

$ ./manning-up.sh

AUTHOR

Written by Leila Muhtasib <muhtasib@gmail.com> Shell Script by Nick Lombard <github@jigsoft.co.za>

REPORTING BUGS

<http://github.com/visionmedia/git-extras/issues>

SEE ALSO

<http://github.com/visionmedia/git-extras>