mr_markdown_builder

Introduction

A fork of the venerable yet archived markdown-builder with improvements including, but not limited to:

• Tables
• Quotes
• Task lists
• Inline code blocks
• Long code blocks
• Badges from shields.io
• GeoJson and TopoJson support
• Collapsible summary/details blocks The motivation behind maintaining this fork is to use the result in the Mediumroast, Inc. application and we did not want to start a new module from scratch when this one already exixted.

Usage

npm install --save mr_markdown_builder

Using mr_markdown_builder:

const markdown = require('mr_markdown_builder')
const { headers } = markdown

headers.hX(3, '3rd Header') // ### 3rd Header

API

Headers

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('mr_markdown_builder')
const { headers } = markdown

headers.h1('1st Header') // # 1st Header
headers.h2('2nd Header') // ## 2nd Header
headers.h3('3rd Header') // ### 3rd Header
headers.hX(5, '5th Header using hX') // ##### 5th Header using hX

Emphasis

const markdown = require('mr_markdown_builder')
const { emphasis } = markdown

emphasis.b('bold text')
emphasis.i('italic text')
emphasis.s('strikethrough text')
emphasis.ic('inline code block text')
emphasis.cb('long code block text')

Lists

const markdown = require('mr_markdown_builder')
const { lists } = markdown

let a = ['Item 1', 'Item 2']
// ordered list
lists.ol(a)
// 1. Item 1
// 2. Item 2
lists.ol(a, (item) => item.toUpperCase()) // use callbacks to alter each item
// 1. ITEM 1
// 2. ITEM 2

// unordered List
lists.ul(a)
lists.ul(a, (item) => item.toUpperCase())

// task list
list.tl(a)
lists.tl(a, (item) => item.toUpperCase())

Miscellaneous

const markdown = require('mr_markdown_builder')
const { misc } = markdown

// Images
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)

// Collapsible summary/details block
misc.collapsible('Summary', 'content');

// Github Anchor
misc.anchor('A header with /*() special-characters!'); // #a-header-with--special-characters

// Link
misc.link('Github', 'https://github.com/flxwu')

// horizontal rule
misc.hr()

// Quote
misc.quote('A quote')

Collapsible:

Summary

Content

Examples

You can check out ./examples/README.md for an example of the module in action, which is created via the test script ./examples/index.js, including the related modules, within the examples directory.

This site is open source. Improve this page.