literature

Write literate code in Markdown, then use Literature to extract code blocks that you can pass to any compiler.

Install

Install with npm

npm i literature --save -g

Usage

Command line

npm i literature -g
literature <file ...>

API

literature = require('literature');
console.log(literature('test.js.md'));

Example

Input

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.

Output

test.js

literature = require('literature');
console.log(literature('test.js.md'));

gulp

There’s a gulp plugin.

npm install --save-dev gulp-literature

About

Documentation often lives a separate life from code, in separate files, stored away in folders. Yet very often prose can make code more comprehensible, while code can be more expressive than prose. They are equally important and should be equal partners.

Literature lets you write prose and code in the same file where they both live not just side by side but together as equal, complementary partners, and that’s A Good Thing.

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.

Issues

Please report any bugs or feature requests, thanks!

Contribute

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

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.

Building the docs

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!

Author

Andreas Pizsa

License

This file was generated by gulp-verb on September 29, 2014.

gitter-badger / literature Goto Github PK

literature's Introduction