Have ideas to improve npm?Join in the discussion! »

    remark-breaks
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.2 • Public • Published

    remark-breaks

    Build Coverage Downloads Size Sponsors Backers Chat

    remark plugin to add break support, without needing spaces.

    Note!

    This plugin is ready for the new parser in remark (micromark, see remarkjs/remark#536). A patch version was released (2.0.1) that works with old and new remark.

    Install

    npm:

    npm install remark-breaks

    Use

    Say we have the following file, example.md (note: there are no spaces after a):

    This is a
    paragraph.

    And our script, example.js, looks as follows:

    var vfile = require('to-vfile')
    var report = require('vfile-reporter')
    var unified = require('unified')
    var markdown = require('remark-parse')
    var remark2rehype = require('remark-rehype')
    var html = require('rehype-stringify')
    var breaks = require('remark-breaks')
    
    unified()
      .use(markdown)
      .use(breaks)
      .use(remark2rehype)
      .use(html)
      .process(vfile.readSync('example.md'), function(err, file) {
        if (err) throw err
        console.log(String(file))
      })

    Now, running node example yields:

    <p>This is a<br>
    paragraph.</p>

    Without remark-breaks, you’d get:

    <p>This is a
    paragraph.</p>

    API

    remark().use(breaks)

    Plugin to add break support without needing spaces. This adds support for GitHub style (in issues, pull requests, comments, and releases) hard breaks without needing spaces before newlines.

    Security

    Use of remark-breaks does not involve rehype (hast) or user content so there are no openings for cross-site scripting (XSS) attacks.

    Related

    Contribute

    See contributing.md in remarkjs/.github for ways to get started. See support.md for ways to get help.

    This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

    License

    MIT © Titus Wormer

    Install

    npm i remark-breaks

    DownloadsWeekly Downloads

    33,288

    Version

    2.0.2

    License

    MIT

    Unpacked Size

    8.62 kB

    Total Files

    5

    Last publish

    Collaborators

    • avatar
    • avatar