Write literate code in markdown, use gulp-literature to compile it
Literature generalizes the idea of Literate CoffeeScript to just any language. It’s just Markdown with code blocks, except that the code blocks are intended to be executed. There are basically only three rules:
- Regular, unfenced code blocks are executable code
- Fenced code blocks are documentation. (That’s handy for usage examples)
.litjs
or.js.md
will result in a.js
file,.litc
or.c.md
will create a.c
file, etc.
test.js.md
# Usage
Literature extracts (unfenced) code blocks - such as the following - from Markdown files:
literature = require('literature');
console.log(literature('test.js.md'));
Sending this file through Literature will output only the above two code lines.
test.js
literature = require('literature');
console.log(literature('test.js.md'));
You can now either directly execute this code or pipe
it to other tools.
npm install gulp-literature --save-dev
See the literature
API and CLI tool.
gulpfile.js
var literature= require('gulp-literature');
var gulp = require('gulp');
var jshint = require('gulp-jshint');
gulp.task('compile',function(){
return gulp.src('test/fixtures/unfenced-code.js.md')
.pipe(literature())
.pipe(jshint())
});
Please report any bugs or feature requests, thanks!
Whatever value you'd like to add to the project, we'd love to have your help! If you'd like to take a more active role, get in touch! We'd be happy to help you get started!
- If you find this project useful please consider "starring" it to show your support!
- Find a bug? Have a feature request? Please create an Issue
- In lieu of a formal styleguide please take care to maintain the existing coding style
- Add unit tests for any new or changed functionality
Pull requests are encouraged! This project builds its our own documentation, so please remember to build the documentation with Verb before you submit your pull request! Please don't edit the readme or other docs directly, edit their respective templates instead.
To build the docs, first make sure verb-cli is installed globally (npm i -g verb-cli
), then just follow these simple steps:
- Edit the templates in the 'docs/' directory, and/or .verbrc.md
- Run
verb
in the command line - Pull request!
Thanks!
Andreas Pizsa
Copyright (c) 2014 Andreas Pizsa, contributors.
Released under the MIT license.
This file was generated by gulp-verb on September 29, 2014.