ms

marked-stream

streaming interface for converting markdown to html with marked

Showing:

Popularity

Downloads/wk

1

GitHub Stars

1

Maintenance

Last Commit

8yrs ago

Contributors

0

Package

Dependencies

2

Size (min+gzip)

5.2KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

marked-stream

build status

NPM

Simple stream that takes a file path and returns a stream of html using marked. Contains sane defaults and highlighting with node-pygmentize-bundled.

Example

var path = require('path');

var markedStream = require('marked-stream');

var example = path.join(__dirname, 'example.md');

//
// You can also pass in `marked` options as second argument
//
var stream = markedStream(example);

stream.on('error', console.log);

stream.pipe(process.stdout)

With the following input:

# Example

Here is an example Markdown file to use for the test

## Hello There

The previous example outputs the following:

<h1>Example</h1>
<p>Here is an example Markdown file to use for the test</p>
<h2>Hello There</h2>

Test

npm test

License

MIT

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial