Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including rollup-plugin-markdown with all npm packages installed. Try it out:

var rollupPluginMarkdown = require("rollup-plugin-markdown")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

rollup-plugin-markdown v0.1.0

import JavaScript from Markdown code blocks

Overview

This Rollup plugin lets you extract your JavaScript code from code blocks embedded in Markdown files, which in turn promotes good written documentation. This technique is called literate programming.

For a more detailed discussion about why you might want to do this, or to implement with other programming languages and other JavaScript build tools, please instead see lit, a shell script which provides the same functionality in a more agnostic fashion.

Example

GitHub Flavored Markdown represents code using fenced code blocks, which are demarcated with three backticks in a row:

function greeting() {
    console.log('hello world');
}

export { greeting };

After you import and run this plugin in your rollup.config.js configuration file, the greeting() function above can be imported directly from this Markdown document! For example, you might use the following ES6 module import statement:

import { greeting } from './path/to/README.md';

Sourcemaps will correctly point your debugging back to the original Markdown documents.

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free