README.md edited online with Bitbucket

This commit is contained in:
David Baer
2016-06-30 18:17:02 +00:00
parent 39314f177e
commit 5080d8311b

View File

@@ -6,13 +6,16 @@ This utility converts text markup into various presentable forms.
Usage
-----
sermon [-s STYLE] INPUT
Usage: sermon [options] FILE
Options:
-h|--help Display this help message
-a|--author AUTHOR Author name
-o|--output OUTPUT Output file name
-s|--stylesheet STYLESHEET Apply stylesheet (default "html5")
-v|--verbose Verbose output
-h Display help message
-s STYLE The stylesheet to use to transform the markup (default: html5)
INPUT Name of markup file (- for stdin)
FILE sermon file to scan ("-" for stdin)
Markup Syntax
@@ -31,10 +34,11 @@ The markup syntax is very simple:
- Leave a blank line between paragraphs.
- Use *asterisks* for emphasis (rendered in italics)
- Use `*asterisks*` for *emphasis* (rendered in italics)
- Use ^{notename} within the text for a footnote/endnote reference.
- Use `^{notename}` within the text for a footnote/endnote reference.
Provide the footnote below your text with
{ref:notename:Author, *Title*. etc...}
- For an offset block quotation, prepend > to each line of a paragraph:
@@ -42,5 +46,4 @@ The markup syntax is very simple:
> This paragraph will be
> a block quote.
- Text enclosed between [* starred braces *] will be ignored as a comment.
- Text enclosed between `[* starred braces *]` will be ignored as a comment.