Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
75lb committed May 29, 2016
1 parent 4ede031 commit 620e603
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -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 <code><a href="https://github.com/75lb/command-line-usage/tree/master#commandlineusagesections--string-">commandLineUsage()</a></code> function takes one or more `section` objects as input. Each section comprises an optional `header` property and one of either <code><a href="https://github.com/75lb/command-line-usage/tree/master#commandlineusagecontent">content</a></code> or <code><a href="https://github.com/75lb/command-line-usage/tree/master#commandlineusageoptionlist">optionList</a></code>.
The <code><a href="#commandlineusagesections--string-">commandLineUsage()</a></code> function takes one or more `section` objects as input. Each section comprises an optional `header` property and one of either <code><a href="#commandlineusagecontent">content</a></code> or <code><a href="#commandlineusageoptionlist">optionList</a></code>.

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).

Expand Down
2 changes: 1 addition & 1 deletion jsdoc2md/README.hbs
Expand Up @@ -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 <code><a href="https://github.com/75lb/command-line-usage/tree/master#commandlineusagesections--string-">commandLineUsage()</a></code> function takes one or more `section` objects as input. Each section comprises an optional `header` property and one of either <code><a href="https://github.com/75lb/command-line-usage/tree/master#commandlineusagecontent">content</a></code> or <code><a href="https://github.com/75lb/command-line-usage/tree/master#commandlineusageoptionlist">optionList</a></code>.
The <code><a href="#commandlineusagesections--string-">commandLineUsage()</a></code> function takes one or more `section` objects as input. Each section comprises an optional `header` property and one of either <code><a href="#commandlineusagecontent">content</a></code> or <code><a href="#commandlineusageoptionlist">optionList</a></code>.

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).

Expand Down

0 comments on commit 620e603

Please sign in to comment.