Markdown builder for Node
Usage
npm install --save markdown-builder
Using markdown-builder
is quite easy:
const markdown = require('markdown-builder');
const { headers } = markdown;
headers.hX(3, '3rd Header')
Example
Check out 30-seconds-of-code's READMEs, they are automatically generated using markdown-builder
API
Use the h1
,h2
,h3
,h4
,h5
,h6
or hX
to generate a markdown header. Calling hX
with a level above 6
returns a h6
Header.
const markdown = require('markdown-builder')
const { headers } = markdown
headers.h1('1st Header')
headers.h2('2nd Header')
headers.h3('3rd Header')
headers.hX(5, '5th Header using hX')
Emphasis
const markdown = require('markdown-builder')
const { emphasis } = markdown
emphasis.b('bold text')
emphasis.i('italic text')
emphasis.s('strikethrough text')
Lists
const markdown = require('markdown-builder')
const { lists } = markdown
let a = ['Item 1', 'Item 2']
lists.ol(a)
lists.ol(a, (item) => item.toUpperCase())
lists.ul(a)
lists.ul(a, (item) => item.toUpperCase())
Miscellaneous
const markdown = require('markdown-builder')
const { misc } = markdown
let alt = 'image of lights', url = 'https://www.w3schools.com/w3css/img_lights.jpg', title = 'lights'
misc.image(alt, url)
misc.image(alt, url, title)
misc.collapsible('Summary', 'content');
misc.anchor('A header with /*() special-characters!');
misc.link('Github', 'https://github.com/flxwu')
misc.hr()
Collapsible:
Summary
Content