mirror of
https://github.com/tj/git-extras.git
synced 2026-09-12 08:26:17 -04:00
65 lines
1.4 KiB
Markdown
65 lines
1.4 KiB
Markdown
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.](https://github.com/rtomayko/ronn)
|
|
|
|
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/tj/git-extras/issues>>
|
|
|
|
## SEE ALSO
|
|
|
|
<<https://github.com/tj/git-extras>>
|