From 5080d8311b309d43b3458918c750de31bac95d2d Mon Sep 17 00:00:00 2001 From: David Baer Date: Thu, 30 Jun 2016 18:17:02 +0000 Subject: [PATCH] README.md edited online with Bitbucket --- README.md | 37 ++++++++++++++++++++----------------- 1 file changed, 20 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index ec1017e..9ae651d 100644 --- a/README.md +++ b/README.md @@ -6,14 +6,17 @@ 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) + FILE sermon file to scan ("-" for stdin) - INPUT Name of markup file (- for stdin) - Markup Syntax ------------- @@ -21,26 +24,26 @@ The markup syntax is very simple: - Provide a header with title and other information at the top: - [title: My Document Title] - [author: My Name] - [date: January 1, 2015] - [occasion: New Year's Day] - [text: Luke 2:21-40] + [title: My Document Title] + [author: My Name] + [date: January 1, 2015] + [occasion: New Year's Day] + [text: Luke 2:21-40] Note that all fields are optional. - 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...} + + {ref:notename:Author, *Title*. etc...} - For an offset block quotation, prepend > to each line of a paragraph: - > This paragraph will be - > a block quote. - - - Text enclosed between [* starred braces *] will be ignored as a comment. + > This paragraph will be + > a block quote. + - Text enclosed between `[* starred braces *]` will be ignored as a comment. \ No newline at end of file