livemd
Generate live-samples from markdown files
With livemd you can easily generate runtime browser samples from corresponding code-blocks contained in markdown-files.
Supported languages:
- HTML
- CSS
- Javascript
- Coffeescript
- SCSS
- Less
- Haml
Install
npm install livemd --save-dev
To use with preprocessor languages you need the appropriate modules to be installed.
npm install coffee-scriptnpm install node-sassnpm install lessnpm install hamljs
Usage
var livemd = ;
Options
options.paths
Type: Array
Default value: []
Provide an array of include paths to pass to scss and less modules. Path to source is included by default.
options.prefilter
Type: Function
Default value: null
Filter the input markdown by providing a function taking the original string as argument and returning the modified string.
options.wrap
Type: String
Default value: '<div class="highlight-example"></div>'
Specify a wrapper for the generated live-samples.
Changelog
- v0.0.6 - Remove debug output ;-)
- v0.0.5 - Fixed fail on combined lexers
- v0.0.3 - Wrap CSS
- v0.0.2 - Added npm install info to README.md
- v0.0.1 - Initial Release