6.6 KiB
mdast-util-newline-to-break
mdast utility to support hard breaks without needing spaces or
escapes (turns enters into <br>s).
Contents
- What is this?
- When should I use this?
- Install
- Use
- API
- Syntax
- Syntax tree
- Types
- Compatibility
- Security
- Related
- Contribute
- License
What is this?
This package is a utility that takes an mdast tree and turns soft line
endings (enters) into hard breaks (<br>s)
This package is used inside remark-breaks, which focusses on making it easier to transform content by abstracting these internals away.
When should I use this?
This plugin is useful if you want to display user content closer to how it was
authored, because when a user includes a line ending, it’ll show as such.
GitHub does this in a few places (comments, issues, PRs, and releases), but it’s
not semantic according to HTML and not compliant to markdown.
Markdown already has two ways to include hard breaks, namely trailing spaces and
escapes (note that ␠ represents a normal space):
lorem␠␠
ipsum
lorem\
ipsum
Both will turn into <br>s.
If you control who authors content or can document how markdown works, it’s
recommended to use escapes instead.
Install
This package is ESM only. In Node.js (version 16+), install with npm:
npm install mdast-util-newline-to-break
In Deno with esm.sh:
import {newlineToBreak} from 'https://esm.sh/mdast-util-newline-to-break@2'
In browsers with esm.sh:
<script type="module">
import {newlineToBreak} from 'https://esm.sh/mdast-util-newline-to-break@2?bundle'
</script>
Use
Say we have the following file, example.md (note: there are no spaces after
a):
This is a
paragraph.
And our module, example.js, looks as follows:
import fs from 'node:fs/promises'
import {fromMarkdown} from 'mdast-util-from-markdown'
import {newlineToBreak} from 'mdast-util-newline-to-break'
import {toMarkdown} from 'mdast-util-to-markdown'
const doc = await fs.readFile('example.md')
const tree = fromMarkdown(doc)
newlineToBreak(tree)
console.log(toMarkdown(tree))
Now, running node example.js yields:
This is a\
paragraph.
API
This package exports the identifier newlineToBreak.
There is no default export.
newlineToBreak(tree)
Turn normal line endings into hard breaks.
Parameters
tree(Node) — tree to modify
Syntax
This utility looks for markdown line endings (\r, \n, and \r\n).
Syntax tree
This utility adds mdast Break nodes to the syntax tree.
These are the same nodes that represent breaks with spaces or escapes.
Types
This package is fully typed with TypeScript. There are no extra exported types.
Compatibility
Projects maintained by the unified collective are compatible with maintained versions of Node.js.
When we cut a new major release, we drop support for unmaintained versions of
Node.
This means we try to keep the current release line,
mdast-util-newline-to-break@^2, compatible with Node.js 16.
Security
Use of mdast-util-newline-to-break does not involve hast or user
content so there are no openings for cross-site scripting (XSS) attacks.
Related
remark-breaks— provide this utility as a unified remark plugin.remark-gfm— support GFM (autolink literals, footnotes, strikethrough, tables, tasklists)remark-github— link references to commits, issues, and users, in the same way that GitHub does
Contribute
See contributing.md in syntax-tree/.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.