0.1.4 • Published 9 years ago

jsmd-rewrite v0.1.4

Weekly downloads
2
License
MIT
Repository
github
Last release
9 years ago

Rewrite code examples in Markdown code blocks as test assertions.

Turns this:

# Title of Your README.md

This is _Markdown_!

<!--javascript
  var additionModule = require('./');
-->

The above won't be rendered in HTML, such as on GitHub or
npmjs.com, but it will be included in the rewritten
JavaScript.

The JavaScript expressions with comments that follow will
be rewritten as asssertions.

```javascript
additionmodule(1, 1); // => 2
additionmodule(2, 2); // => 4
```

into this:

var additionModule = require('./');
__jsmd__(additionModule(l, 1), 2, 'line 1');
__jsmd__(additionModule(2, 2), 4, 'line 2');

Command-Line Interface

$ npm install --global jsmd-rewrite
$ jsmd-rewrite --version
$ jsmd-rewrite --help
$ jsmd-rewrite README.md
$ cat README.md | jsmd-rewrite

Node.js

Install:

$ npm install --save jsmd-rewrite

then:

var rewrite = require('jsmd-rewrite');
rewrite(markdown); // returns string
rewrite(markdown, assertionFunctionName); // returns string

The function name used for assertions is "__jsmd__" by default.

License

The one and only original jsmd is copyright Veselin Todorov and maintained by Veselin Todorov and Jake Rosoman. This package incorporates jsmd's rewriting logic with adaptations by Kyle Mitchell. jsmd-rewrite, like jsmd, is licensed per the terms of the MIT License.