National Poetry Month

    remark-code-blocks

    2.0.1 • Public • Published

    remark-code-blocks

    Remark plugin to extract code nodes from markdown.

    Travis CoverageStatus

    Install

    npm i -S remark-code-blocks
    

    Usage

    const toVfile = require('to-vfile')
    const unified = require('unified')
    const parser = require('remark-parser')
    const stringify = require('remark-stringify')
    const codeblocks = require('remark-code-blocks')
     
    unified()
        .use(parser)
        .use(stringify)
        .use(codeblocks, { /* options */ })
        .process(toVfile('./example.md'))
        .then(file => {
            /* file.data.codeblocks = [ ... ] */
        })

    or use the standalone function which takes a tree as its first argument.

    const toVfile = require('to-vfile')
    const unified = require('unified')
    const parser = require('remark-parser')
    const { codeblocks } = require('remark-code-blocks')
     
    const tree = unified().use(parser).parse(toVfile('./example.md'))
    const code = codeblocks(tree, { /* options */ })

    API

    .use(codeblocks[, options])

    Use as a plugin to extract code nodes.

    The results are stored in file.data in a codeblocks property by default. You can override the name of the property using options.name.

    .codeblocks(tree[, options])

    Also exports a standalone function.

    Options

    lang

    Type: string Default: all

    Specify a language and only extract code nodes with that language. Otherwise all code nodes are extracted.

    name

    Type: string Default: codeblocks

    Specify the name of the property in file.data

    formatter

    Type: function Default: none

    Add a function to run over the nodes values before storing them in file.data

    License

    MIT © Paul Zimmer

    Install

    npm i remark-code-blocks

    DownloadsWeekly Downloads

    4,991

    Version

    2.0.1

    License

    MIT

    Unpacked Size

    12.5 kB

    Total Files

    11

    Last publish

    Collaborators

    • mrzmmr