Convert command help string to Markdown.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
test
Makefile
README.md
UNLICENSE
between-tags
between-tags.awk
help2md
help2md-in-place
help2md-tags
help2md.awk
package.json

README.md

help2md npm version

Convert command help string to Markdown.

Usage

# Show markdown equivalent of help text.
some-program --help | help2md

# Output a new readme, with newly generated help between
# `<!-- BEGIN USAGE -->` and `<!-- END USAGE -->` tags.
some-program --help | help2md-tags README.md

# Modify readme in place with new help between tags (like above).
some-program --help | help2md-in-place README.md

Examples

See the tests for example parsing.

You can also look gogs-migrate's package.json which is using help2md to update it's readme in place.