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
npm install livemd --save-devTo use with preprocessor languages you need the appropriate modules to be installed.
npm install coffee-script
npm install node-sass
npm install less
npm install hamljsvar livemd = require('livemd');
livemd(src).done(function(result) {
// Do something with the result
})Type: Array
Default value: []
Provide an array of include paths to pass to scss and less modules. Path to source is included by default.
Type: Function
Default value: null
Filter the input markdown by providing a function taking the original string as argument and returning the modified string.
Type: String
Default value: '<div class="highlight-example"></div>'
Specify a wrapper for the generated live-samples.
See these demo sites created with grunt-livemd
- 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