Brunobkr/llama.cpp_AlgMor24_github

1# remark-breaks2 3[![Build][build-badge]][build]4[![Coverage][coverage-badge]][coverage]5[![Downloads][downloads-badge]][downloads]6[![Size][size-badge]][size]7[![Sponsors][sponsors-badge]][collective]8[![Backers][backers-badge]][collective]9[![Chat][chat-badge]][chat]10 11**[remark][]** plugin to support hard breaks without needing spaces or escapes12(turns enters into `<br>`s).13 14## Contents15 16*   [What is this?](#what-is-this)17*   [When should I use this?](#when-should-i-use-this)18*   [Install](#install)19*   [Use](#use)20*   [API](#api)21    *   [`unified().use(remarkBreaks)`](#unifieduseremarkbreaks)22*   [Syntax](#syntax)23*   [Syntax tree](#syntax-tree)24*   [Types](#types)25*   [Compatibility](#compatibility)26*   [Security](#security)27*   [Related](#related)28*   [Contribute](#contribute)29*   [License](#license)30 31## What is this?32 33This package is a [unified][] ([remark][]) plugin to turn soft line endings34(enters) into hard breaks (`<br>`s)35 36## When should I use this?37 38This plugin is useful if you want to display user content closer to how it was39authored, because when a user includes a line ending, it’ll show as such.40GitHub does this in a few places (comments, issues, PRs, and releases), but it’s41not semantic according to HTML and not compliant to markdown.42Markdown already has two ways to include hard breaks, namely trailing spaces and43escapes (note that `␠` represents a normal space):44 45```markdown46lorem␠␠47ipsum48 49lorem\50ipsum51```52 53Both will turn into `<br>`s.54If you control who authors content or can document how markdown works, it’s55recommended to use escapes instead.56 57## Install58 59This package is [ESM only][esm].60In Node.js (version 16+), install with [npm][]:61 62```sh63npm install remark-breaks64```65 66In Deno with [`esm.sh`][esmsh]:67 68```js69import remarkBreaks from 'https://esm.sh/remark-breaks@4'70```71 72In browsers with [`esm.sh`][esmsh]:73 74```html75<script type="module">76  import remarkBreaks from 'https://esm.sh/remark-breaks@4?bundle'77</script>78```79 80## Use81 82Say we have the following file `example.md` (note: there are no spaces after83`a`):84 85```markdown86Mars is87the fourth planet88```89 90…and a module `example.js`:91 92```js93import rehypeStringify from 'rehype-stringify'94import remarkBreaks from 'remark-breaks'95import remarkParse from 'remark-parse'96import remarkRehype from 'remark-rehype'97import {read} from 'to-vfile'98import {unified} from 'unified'99 100const file = await unified()101  .use(remarkParse)102  .use(remarkBreaks)103  .use(remarkRehype)104  .use(rehypeStringify)105  .process(await read('example.md'))106 107console.log(String(file))108```109 110…then running `node example.js` yields:111 112```html113<p>Mars is<br>114the fourth planet</p>115```116 117> 👉 **Note**: Without `remark-breaks`, you’d get:118>119> ```html120> <p>Mars is121> the fourth planet</p>122> ```123 124## API125 126This package exports no identifiers.127The default export is [`remarkBreaks`][api-remark-breaks].128 129### `unified().use(remarkBreaks)`130 131Support hard breaks without needing spaces or escapes (turns enters into132`<br>`s).133 134###### Parameters135 136There are no parameters.137 138###### Returns139 140Transform ([`Transformer`][unified-transformer]).141 142## Syntax143 144This plugin looks for markdown line endings (`\r`, `\n`, and `\r\n`) preceded145by zero or more spaces and tabs.146 147## Syntax tree148 149This plugin adds mdast [`Break`][mdast-break] nodes to the syntax tree.150These are the same nodes that represent breaks with spaces or escapes.151 152## Types153 154This package is fully typed with [TypeScript][].155It exports no additional types.156 157## Compatibility158 159Projects maintained by the unified collective are compatible with maintained160versions of Node.js.161 162When we cut a new major release, we drop support for unmaintained versions of163Node.164This means we try to keep the current release line, `remark-breaks@^4`,165compatible with Node.js 16.166 167This plugin works with `unified` version 6+ and `remark` version 7+.168 169## Security170 171Use of `remark-breaks` does not involve **[rehype][]** (**[hast][]**) or user172content so there are no openings for [cross-site scripting (XSS)][wiki-xss]173attacks.174 175## Related176 177*   [`remark-gfm`](https://github.com/remarkjs/remark-gfm)178    — support GFM (autolink literals, footnotes, strikethrough, tables,179    tasklists)180*   [`remark-github`](https://github.com/remarkjs/remark-github)181    — link references to commits, issues, and users, in the same way that182    GitHub does183*   [`remark-directive`](https://github.com/remarkjs/remark-directive)184    — support directives185*   [`remark-frontmatter`](https://github.com/remarkjs/remark-frontmatter)186    — support frontmatter (YAML, TOML, and more)187*   [`remark-math`](https://github.com/remarkjs/remark-math)188    — support math189 190## Contribute191 192See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways193to get started.194See [`support.md`][support] for ways to get help.195 196This project has a [code of conduct][coc].197By interacting with this repository, organization, or community you agree to198abide by its terms.199 200## License201 202[MIT][license] © [Titus Wormer][author]203 204<!-- Definitions -->205 206[build-badge]: https://github.com/remarkjs/remark-breaks/workflows/main/badge.svg207 208[build]: https://github.com/remarkjs/remark-breaks/actions209 210[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-breaks.svg211 212[coverage]: https://codecov.io/github/remarkjs/remark-breaks213 214[downloads-badge]: https://img.shields.io/npm/dm/remark-breaks.svg215 216[downloads]: https://www.npmjs.com/package/remark-breaks217 218[size-badge]: https://img.shields.io/bundlejs/size/remark-breaks219 220[size]: https://bundlejs.com/?q=remark-breaks221 222[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg223 224[backers-badge]: https://opencollective.com/unified/backers/badge.svg225 226[collective]: https://opencollective.com/unified227 228[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg229 230[chat]: https://github.com/remarkjs/remark/discussions231 232[npm]: https://docs.npmjs.com/cli/install233 234[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c235 236[esmsh]: https://esm.sh237 238[health]: https://github.com/remarkjs/.github239 240[contributing]: https://github.com/remarkjs/.github/blob/main/contributing.md241 242[support]: https://github.com/remarkjs/.github/blob/main/support.md243 244[coc]: https://github.com/remarkjs/.github/blob/main/code-of-conduct.md245 246[license]: license247 248[author]: https://wooorm.com249 250[hast]: https://github.com/syntax-tree/hast251 252[mdast-break]: https://github.com/syntax-tree/mdast#break253 254[rehype]: https://github.com/rehypejs/rehype255 256[remark]: https://github.com/remarkjs/remark257 258[typescript]: https://www.typescriptlang.org259 260[unified]: https://github.com/unifiedjs/unified261 262[unified-transformer]: https://github.com/unifiedjs/unified#transformer263 264[wiki-xss]: https://en.wikipedia.org/wiki/Cross-site_scripting265 266[api-remark-breaks]: #unifieduseremarkbreaks267