Giter Club home page Giter Club logo

streamdown's Introduction

Top lang Vulnerabilities Version Last commit Minified size Codecov Downloads

LOOKING FOR MAINTAINERS: DM @v_1rtl on telegram or email on [email protected]

Streamdown

Stream markdown to HTML using marked that later can be piped to response.

WARNING!!! Markdown wasn't intended to be streamable so this library has a lot of limitations. Splitting markdown in chunks might break code markup, folded lists and link references. Use this library only for very basic markdown. The better approach would be using a string instead. A detailed explanation of why Streamdown is not the best approach is written here.

Install

pnpm i streamdown

Usage

import { createServer } from 'http'
import { streamdown } from 'streamdown'
import { createReadStream } from 'fs'

createServer((_, res) => {
  createReadStream('page.md').pipe(streamdown()).pipe(res)
}).listen(3000)

API

import { streamdown, Streamdown } from 'streamdown'

new Streamdown(opts)

Create a new Streamdown transform stream with options for transform and MarkedOptions from marked

const md = new Streamdown({
  markedOptions: {
    headerIds: false
  },
  transformOptions: {
    encoding: 'utf8'
  }
})

streamdown(opts)

Create a new Streamdown transform stream and return it.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.