markdown/README.template.md in markdown_helper-1.7.0 vs markdown/README.template.md in markdown_helper-1.8.0

- old
+ new

@@ -4,12 +4,12 @@ ## What's New? Command-line interface is now supported: -* ```markdown_helper include [options] template_file_path markdown_file_path``` -* ```markdown_helper resolve [options] template_file_path markdown_file_path``` +* Added first [use cases](markdown/use_cases/use_cases.md#use-cases) (there will be more). +* Deprecated treatment ```:verbatim```, changing to ```:markdown```. The older term could be confusing, because although text to be treated ```:verbatim``` is included 'verbatim' (without change), it will be processed as GitHub markdown. ## What's This? Class <code>MarkdownHelper</code> supports: @@ -57,15 +57,15 @@ #### Comment Comment text is written into the output between the comment delimiters <code>\<!--</code> and <code>--></code> -#### Verbatim +#### Markdown -Verbatim text is included unadorned. Most often, verbatim text is markdown to be rendered as part of the markdown page. +Markdown text is included unadorned, and will be processed on GitHub as markdown. -The verbatim text is itself scanned for nested includes. +The markdown text is itself scanned for nested includes. ### Usage #### CLI @@ -84,10 +84,10 @@ where: * *format* (in square brackets) is one of the following: * Highlighting mode such as <code>[ruby]</code>, to include a highlighted code block. This can be any Ace mode mentioned in [GitHub Languages](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml). * <code>[:code_block]</code>, to include a plain code block. - * <code>[:verbatim]</code>, to include text verbatim (to be rendered as markdown). + * <code>[:markdown]</code>, to include text markdown (to be rendered as markdown). * *relative_file_path* points to the file to be included. ##### Example Include Descriptions @[code_block](include.md)