7007b6e6e5
Bash script which rebuilds the indexes (index.txt and the links listed in git-extras.md) based on the collection of .md file documents avalable. By interrogating the .md file for the documented description we null and void yet another possible consistency issue and avoid manual duplication mistakes. Once the indexes are up to date we start from the begining of the directory listing again calling ronn on each .md to generate the man and html files as well as renaming the incerrectly name html file. Result several incorrectly named .html documents are now removed, and all the documentation is up to date. Documentation also updated.
1.2 KiB
How to generate documentation:
DESCRIPTION
To generate documentation:
-
Start by filling out the 'man-template.md'
-
Then use a program ronn. Get ronn from github.
-
Run ronn:
$ronn <filename>.md
-
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>