@rgrannell/markdown v9.4.0

markdown (v9.3.0)

Stability

0 - Experimental

A utility library for generating markdown from JavaScript

Table of Contents

• markdown.h1
  • Parameters
• markdown.h2
  • Parameters
• markdown.h3
  • Parameters
• markdown.h4
  • Parameters
• markdown.h5
  • Parameters
• markdown.h6
  • Parameters
• markdown.italic
  • Parameters
• markdown.bold
  • Parameters
• markdown.mono
  • Parameters
• markdown.link
  • Parameters
• markdown.rule
• markdown.list
  • Parameters
• markdown.code
  • Parameters
• markdown.document
  • Parameters

API Documentation

markdown.h1

Create a heading equivalent to

Parameters

• text String the heading text to display.

Returns text a markdown string displaying a header.

markdown.h2

Create a heading equivalent to

Parameters

• text String the heading text to display.

Returns text a markdown string displaying a header.

markdown.h3

Create a heading equivalent to

Parameters

• text String the heading text to display.

Returns text a markdown string displaying a header.

markdown.h4

Create a heading equivalent to

Parameters

• text String the heading text to display.

Returns text a markdown string displaying a header.

markdown.h5

Create a heading equivalent to

Parameters

• text String the heading text to display.

Returns text a markdown string displaying a header.

markdown.h6

Create a heading equivalent to

Parameters

• text String the heading text to display.

Returns text a markdown string displaying a header.

markdown.italic

Create italic text

Parameters

• text String the text to italicise.

Returns text a markdown string displaying italic text.

markdown.bold

Create bold text

Parameters

• text String the text to embolden.

Returns text a markdown string displaying bold text.

markdown.mono

Create monospace text

Parameters

• text String the target text.

Returns text monospaced text.

markdown.link

Create a link

Parameters

• text String the text description
• link String the URL

Returns text a markdown link.

markdown.rule

Create a divider

Returns text a markdown divider.

markdown.list

Create a markdown list

Parameters

• lines Array<string> an array of list entries.

Returns text a markdown string displaying a list.

markdown.code

Create a markdown code block

Parameters

• text String the source-code.

Returns text a code block

markdown.document

Create a markdown document

Parameters

• lines Array<string> the heading text to display.

Returns text a markdown doucment.

Dependencies

• Node.js >= v10.6.0
• NPM >= v10.6.0

License

Copyright (c) 2020 Róisín Grannell

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.