Skip to content

Latest commit

 

History

History
 
 

man

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Readme.md
Readme.md
 
 
git-alias.1
git-alias.1
 
 
git-alias.html
git-alias.html
 
 
git-alias.md
git-alias.md
 
 
git-archive-file.1
git-archive-file.1
 
 
git-archive-file.html
git-archive-file.html
 
 
git-archive-file.md
git-archive-file.md
 
 
git-authors.1
git-authors.1
 
 
git-authors.html
git-authors.html
 
 
git-authors.md
git-authors.md
 
 
git-back.1
git-back.1
 
 
git-back.html
git-back.html
 
 
git-back.md
git-back.md
 
 
git-bug.1
git-bug.1
 
 
git-bug.html
git-bug.html
 
 
git-bug.md
git-bug.md
 
 
git-changelog.1
git-changelog.1
 
 
git-changelog.html
git-changelog.html
 
 
git-changelog.md
git-changelog.md
 
 
git-chore.1
git-chore.1
 
 
git-chore.html
git-chore.html
 
 
git-chore.md
git-chore.md
 
 
git-commits-since.1
git-commits-since.1
 
 
git-commits-since.html
git-commits-since.html
 
 
git-commits-since.md
git-commits-since.md
 
 
git-contrib.1
git-contrib.1
 
 
git-contrib.html
git-contrib.html
 
 
git-contrib.md
git-contrib.md
 
 
git-count.1
git-count.1
 
 
git-count.html
git-count.html
 
 
git-count.md
git-count.md
 
 
git-create-branch.1
git-create-branch.1
 
 
git-create-branch.html
git-create-branch.html
 
 
git-create-branch.md
git-create-branch.md
 
 
git-delete-branch.1
git-delete-branch.1
 
 
git-delete-branch.html
git-delete-branch.html
 
 
git-delete-branch.md
git-delete-branch.md
 
 
git-delete-merged-branches.1
git-delete-merged-branches.1
 
 
git-delete-merged-branches.html
git-delete-merged-branches.html
 
 
git-delete-merged-branches.md
git-delete-merged-branches.md
 
 
git-delete-submodule.1
git-delete-submodule.1
 
 
git-delete-submodule.html
git-delete-submodule.html
 
 
git-delete-submodule.md
git-delete-submodule.md
 
 
git-delete-tag.1
git-delete-tag.1
 
 
git-delete-tag.html
git-delete-tag.html
 
 
git-delete-tag.md
git-delete-tag.md
 
 
git-delta.1
git-delta.1
 
 
git-delta.html
git-delta.html
 
 
git-delta.md
git-delta.md
 
 
git-effort.1
git-effort.1
 
 
git-effort.html
git-effort.html
 
 
git-effort.md
git-effort.md
 
 
git-extras.1
git-extras.1
 
 
git-extras.html
git-extras.html
 
 
git-extras.md
git-extras.md
 
 
git-feature.1
git-feature.1
 
 
git-feature.html
git-feature.html
 
 
git-feature.md
git-feature.md
 
 
git-fork.1
git-fork.1
 
 
git-fork.html
git-fork.html
 
 
git-fork.md
git-fork.md
 
 
git-fresh-branch.1
git-fresh-branch.1
 
 
git-fresh-branch.html
git-fresh-branch.html
 
 
git-fresh-branch.md
git-fresh-branch.md
 
 
git-gh-pages.1
git-gh-pages.1
 
 
git-gh-pages.html
git-gh-pages.html
 
 
git-gh-pages.md
git-gh-pages.md
 
 
git-graft.1
git-graft.1
 
 
git-graft.html
git-graft.html
 
 
git-graft.md
git-graft.md
 
 
git-guilt.1
git-guilt.1
 
 
git-guilt.html
git-guilt.html
 
 
git-guilt.md
git-guilt.md
 
 
git-ignore.1
git-ignore.1
 
 
git-ignore.html
git-ignore.html
 
 
git-ignore.md
git-ignore.md
 
 
git-info.1
git-info.1
 
 
git-info.html
git-info.html
 
 
git-info.md
git-info.md
 
 
git-line-summary.1
git-line-summary.1
 
 
git-line-summary.html
git-line-summary.html
 
 
git-line-summary.md
git-line-summary.md
 
 
git-local-commits.1
git-local-commits.1
 
 
git-local-commits.html
git-local-commits.html
 
 
git-local-commits.md
git-local-commits.md
 
 
git-lock.1
git-lock.1
 
 
git-lock.html
git-lock.html
 
 
git-lock.md
git-lock.md
 
 
git-locked.1
git-locked.1
 
 
git-locked.html
git-locked.html
 
 
git-locked.md
git-locked.md
 
 
git-merge-into.1
git-merge-into.1
 
 
git-merge-into.html
git-merge-into.html
 
 
git-merge-into.md
git-merge-into.md
 
 
git-merge-repo.1
git-merge-repo.1
 
 
git-merge-repo.html
git-merge-repo.html
 
 
git-merge-repo.md
git-merge-repo.md
 
 
git-missing.1
git-missing.1
 
 
git-missing.html
git-missing.html
 
 
git-missing.md
git-missing.md
 
 

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
  1. 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 <[email protected]> Shell Script by Nick Lombard <[email protected]>

REPORTING BUGS

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

SEE ALSO

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