From 620e6039918b6ce570a61ce1e09ae64d1e6b8cbd Mon Sep 17 00:00:00 2001 From: Lloyd Brookes Date: Sun, 29 May 2016 13:08:43 +0100 Subject: [PATCH] docs --- README.md | 2 +- jsdoc2md/README.hbs | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3b6c4b5..3eeb53d 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ A simple module for creating a usage guide. ## Synopis A usage guide is built from an arbitrary number of sections, e.g. a description section, synopsis, option list, examples, footer etc. Each section has a bold, underlined header and some content (a paragraph, table, option list, banner etc.) -The commandLineUsage() function takes one or more `section` objects as input. Each section comprises an optional `header` property and one of either content or optionList. +The commandLineUsage() function takes one or more `section` objects as input. Each section comprises an optional `header` property and one of either content or optionList. Inline ansi formatting can be used anywhere within section content using the formatting syntax described [here](https://github.com/75lb/ansi-escape-sequences#module_ansi-escape-sequences.format). diff --git a/jsdoc2md/README.hbs b/jsdoc2md/README.hbs index 31c145f..c66a9c1 100644 --- a/jsdoc2md/README.hbs +++ b/jsdoc2md/README.hbs @@ -10,7 +10,7 @@ A simple module for creating a usage guide. ## Synopis A usage guide is built from an arbitrary number of sections, e.g. a description section, synopsis, option list, examples, footer etc. Each section has a bold, underlined header and some content (a paragraph, table, option list, banner etc.) -The commandLineUsage() function takes one or more `section` objects as input. Each section comprises an optional `header` property and one of either content or optionList. +The commandLineUsage() function takes one or more `section` objects as input. Each section comprises an optional `header` property and one of either content or optionList. Inline ansi formatting can be used anywhere within section content using the formatting syntax described [here](https://github.com/75lb/ansi-escape-sequences#module_ansi-escape-sequences.format).