Skip to content
Fetching latest commit…
Cannot retrieve the latest commit at this time.
..
Failed to load latest commit information.
Readme.md
git-alias.1
git-alias.html
git-alias.md
git-back.1
git-back.html
git-back.md
git-bug.1
git-bug.html
git-bug.md
git-changelog.1
git-changelog.html
git-changelog.md
git-commits-since.1
git-commits-since.html
git-commits-since.md
git-contrib.1
git-contrib.html
git-contrib.md
git-count.1
git-count.html
git-count.md
git-create-branch.1
git-create-branch.html
git-create-branch.md
git-delete-branch.1
git-delete-branch.html
git-delete-branch.md
git-delete-merged-branches.1
git-delete-merged-branches.html
git-delete-merged-branches.md
git-delete-submodule.1
git-delete-submodule.html
git-delete-submodule.md
git-delete-tag.1
git-delete-tag.html
git-delete-tag.md
git-effort.1
git-effort.html
git-effort.md
git-extras.1
git-extras.html
git-extras.md
git-feature.1
git-feature.html
git-feature.md
git-fresh-branch.1
git-fresh-branch.html
git-fresh-branch.md
git-gh-pages.1
git-gh-pages.html
git-gh-pages.md
git-graft.1
git-graft.html
git-graft.md
git-ignore.1
git-ignore.html
git-ignore.md
git-info.1
git-info.html
git-info.md
git-local-commits.1
git-local-commits.html
git-local-commits.md
git-refactor.1
git-refactor.html
git-refactor.md
git-release.1
git-release.html
git-release.md
git-rename-tag.1
git-rename-tag.html
git-rename-tag.md
git-repl.1
git-repl.html
git-repl.md
git-setup.1
git-setup.html
git-setup.md
git-show-tree.1
git-show-tree.html
git-show-tree.md
git-squash.1
git-squash.html
git-squash.md
git-summary.1
git-summary.html
git-summary.md
git-touch.1
git-touch.html
git-touch.md
git-undo.1
git-undo.html
git-undo.md
index.txt
man-template.md
manning-up.sh

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

To only (re)generate a specific .md manual template and have .1.html renamed to .html yau may also use manning-up.sh.

$ ./manning-up.sh git-info.md

AUTHOR

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

REPORTING BUGS

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

SEE ALSO

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

Something went wrong with that request. Please try again.