markdown-content-blocks

Parses content blocks into Markdown

Inspired by iA Writer’s content blocks, a file transclusion syntax for Markdown, as specced here.

Install

$ npm install markdown-content-blocks

Usage

const contentBlocks = require('markdown-content-blocks')

let source = `
# Title

/example.js
/moretext.txt
/https://i.imgur.com/p66zLsr.jpg
/localimage.jpg
`

let blocks = {
	'example.js': `console.log('Hello World');`,
	'moretext.txt': 'Here be text'
}

let markdown = contentBlocks(source, blocks)

// # Title
//
// ```javascript
// console.log('Hello World');
// ```
//
// Here be text
//
// ![](https://i.imgur.com/p66zLsr.jpg "")
//
// ![](/localimage.jpg "")

API

contentBlocks(markdown, blocks, options?)

contentBlocks.replace(markdown, blocks, options?)

Returns a Markdown string.

markdown

Type: string

Markdown string to be parsed.

blocks

Type: object

Key/value pairs where the key is the content block (a file name or path) that should be replaced; value is the replacement value:

let blocks = {
	'example.js': `console.log('Hello World');`,
	'moretext.txt': 'Here be text'
}

options

Type: object

imagePath

Type: string
Default: /

Sets the path that local images will be prefixed with. The image’s URI is prefixed as you configured it, so omit a leading slash for relative paths.

let source = `
/myfamily.jpg
`

let markdown = contentBlocks(source, {}, { imagePath: 'images' })

// ![](images/myfamily.jpg "")

contentBlocks.getBlocks(markdown)

Returns an array of content blocks (file names or paths) that were found in the given Markdown string.

Note: content blocks that appear to be images are ignored.

let blocks = contentBlocks.getBlocks(source) //=> ['example.js', 'moretext.txt']

markdown

Type: string

Notes

• Doesn’t embed .csv content blocks as tables
• Doesn’t syntax highlight everything mentioned in iA’s spec (instead, it does most of what Prism.js supports)
• Formats anything resembling an image URL (/myimage.jpg) as an image block and optionally empty title ![](/myimage.jpg "")). No alt text is supported as of now; the iA Writer 'spec' is lacking in this regard.
• Ignores titles for code blocks, as there is no Markdown syntax for titles/captions for (fenced) code blocks. Same goes for text blocks (.md and .txt).

License

MIT © Anne Fortuin