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 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 FILE sermon file to scan ("-" for stdin)
-s STYLE The stylesheet to use to transform the markup (default: html5)
INPUT Name of markup file (- for stdin)
Markup Syntax Markup Syntax
@@ -21,26 +24,26 @@ The markup syntax is very simple:
- Provide a header with title and other information at the top: - Provide a header with title and other information at the top:
[title: My Document Title] [title: My Document Title]
[author: My Name] [author: My Name]
[date: January 1, 2015] [date: January 1, 2015]
[occasion: New Year's Day] [occasion: New Year's Day]
[text: Luke 2:21-40] [text: Luke 2:21-40]
Note that all fields are optional. Note that all fields are optional.
- Leave a blank line between paragraphs. - 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 Provide the footnote below your text with
{ref:notename:Author, *Title*. etc...}
{ref:notename:Author, *Title*. etc...}
- For an offset block quotation, prepend > to each line of a paragraph: - For an offset block quotation, prepend > to each line of a paragraph:
> This paragraph will be > This paragraph will be
> a block quote. > 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.