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- 815db8b89e help ronn make hyperlinks. 
With hte manuals described in index.txt ronn will create hyperlinks of the (1) referenced words.
See http://rtomayko.github.com/ronn/ronn.1#LINK-INDEXES.
git-extras.html will now be browsable, actually anywhere else you use the referenced names ie. git-extras(1) as defined in index.txt will generate as hyperlinks in html while keeping the text versions rendereder similarly than they used to using exactly the same procedures as already documented.
2012-07-21 12:25:58 +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 Built docs 2010-10-31 11:51:12 -07:00
git-commits-since.html Added html docs 2010-10-31 11:51:24 -07:00
git-commits-since.md Renamed man pages to *.md 2010-10-31 11:41:30 -07: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 help ronn make hyperlinks. 2012-07-21 12:25:58 +02:00
git-extras.html help ronn make hyperlinks. 2012-07-21 12:25:58 +02:00
git-extras.md help ronn make hyperlinks. 2012-07-21 12:25:58 +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 Added git-extras, removed git-extras-version and git-extras-update 2011-03-27 09:01:40 -07:00
git-ignore.html Added git-extras, removed git-extras-version and git-extras-update 2011-03-27 09:01:40 -07:00
git-ignore.md Added git-extras, removed git-extras-version and git-extras-update 2011-03-27 09:01:40 -07:00
git-info.1 Added documentation for git-info command. 2012-06-16 12:32:41 -04:00
git-info.html Added documentation for git-info command. 2012-06-16 12:32:41 -04:00
git-info.md Added documentation for git-info command. 2012-06-16 12:32:41 -04: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-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 docs 2011-03-29 08:58:12 -07:00
git-undo.html docs 2011-03-29 08:58:12 -07:00
git-undo.md Renamed man pages to *.md 2010-10-31 11:41:30 -07:00
index.txt help ronn make hyperlinks. 2012-07-21 12:25:58 +02:00
man-template.md Renamed man pages to *.md 2010-10-31 11:41:30 -07:00
Readme.md Updated git-extras to include git-effort. 2012-06-12 17:15:00 -04: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

AUTHOR

Written by Leila Muhtasib <muhtasib@gmail.com>

REPORTING BUGS

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

SEE ALSO

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