https://github.com/jpommerening/node-md-code-stream

Extract code blocks from Markdown streams
https://github.com/jpommerening/node-md-code-stream

Last synced: 24 days ago
JSON representation

Extract code blocks from Markdown streams

• Host: GitHub
• URL: https://github.com/jpommerening/node-md-code-stream
• Owner: jpommerening
• License: mit
• Created: 2014-05-23T13:55:50.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-07-11T09:54:15.000Z (over 10 years ago)
• Last Synced: 2024-08-08T15:45:33.839Z (3 months ago)
• Language: JavaScript
• Size: 211 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-MIT

Awesome Lists containing this project

README

        
# md-code-stream

> Extract code blocks from Markdown streams, so you can test them

## Examples

In this example, we parse *this* `README.md` file and extract the first code

block:

```js

var fs = require('fs');

var assert = require('assert');

var mdCodeStream = require('md-code-stream');

var readme = fs.createReadStream('README.md')

               .pipe(mdCodeStream());

readme.once('entry', function(entry) {

  assert.equal(entry.section[0], 'md-code-stream');

  assert.equal(entry.section[1], 'Examples');

  assert.equal(entry.num, 0);

  assert.equal(entry.language, 'js');

  assert.equal(entry.props.path, 'md-code-stream/examples.js');

  // At this point we could also pipe it to stdout:

  // entry.pipe(process.stdout);

});

```

When given a filename as the first argument, the file will be opened

and piped into the stream. The stream also collects all it's entries in

the `entries` property:

```js

var assert = require('assert');

var mdCodeStream = require('md-code-stream');

var readme = mdCodeStream('README.md');

readme.on('end', function() {

  assert.equal(readme.entries.length, 3);

});

```

The stream is compatible with [`fstream`](https://npmjs.org/package/fstream),

so you can pipe it to a directory:

```js

var fs = require('fs');

var fstream = require('fstream');

var assert = require('assert');

var mdCodeStream = require('md-code-stream');

fs.createReadStream('README.md')

  .pipe(mdCodeStream())

  .pipe(fstream.Writer({path: 'tmp', type: 'Directory'}))

  .on('close', function() {

    assert(fs.existsSync('tmp/md-code-stream/examples.js'));

    assert(fs.existsSync('tmp/md-code-stream/examples-1.js'));

    assert(fs.existsSync('tmp/md-code-stream/examples-2.js'));

  });

```