Brunobkr/llama.cpp_AlgMor24_github

1# remark2 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**[unified][]** processor with support for parsing from markdown and12serializing to markdown.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    *   [`remark()`](#remark-1)22*   [Examples](#examples)23    *   [Example: checking markdown](#example-checking-markdown)24    *   [Example: passing options to `remark-stringify`](#example-passing-options-to-remark-stringify)25*   [Syntax](#syntax)26*   [Syntax tree](#syntax-tree)27*   [Types](#types)28*   [Compatibility](#compatibility)29*   [Security](#security)30*   [Contribute](#contribute)31*   [Sponsor](#sponsor)32*   [License](#license)33 34## What is this?35 36This package is a [unified][] processor with support for parsing markdown as37input and serializing markdown as output by using unified with38[`remark-parse`][remark-parse] and [`remark-stringify`][remark-stringify].39 40See [the monorepo readme][remark] for info on what the remark ecosystem is.41 42## When should I use this?43 44You can use this package when you want to use unified, have markdown as input,45and want markdown as output.46This package is a shortcut for47`unified().use(remarkParse).use(remarkStringify)`.48When the input isn’t markdown (meaning you don’t need `remark-parse`) or the49output is not markdown (you don’t need `remark-stringify`), it’s recommended to50use `unified` directly.51 52When you want to inspect and format markdown files in a project on the command53line, you can use [`remark-cli`][remark-cli].54 55## Install56 57This package is [ESM only][esm].58In Node.js (version 16+), install with [npm][]:59 60```sh61npm install remark62```63 64In Deno with [`esm.sh`][esmsh]:65 66```js67import {remark} from 'https://esm.sh/remark@15'68```69 70In browsers with [`esm.sh`][esmsh]:71 72```html73<script type="module">74  import {remark} from 'https://esm.sh/remark@15?bundle'75</script>76```77 78## Use79 80Say we have the following module `example.js`:81 82```js83import {remark} from 'remark'84import remarkToc from 'remark-toc'85 86const doc = `87# Pluto88 89Pluto is a dwarf planet in the Kuiper belt.90 91## Contents92 93## History94 95### Discovery96 97In the 1840s, Urbain Le Verrier used Newtonian mechanics to predict the position of…98 99### Name and symbol100 101The name Pluto is for the Roman god of the underworld, from a Greek epithet for Hades…102 103### Planet X disproved104 105Once Pluto was found, its faintness and lack of a viewable disc cast doubt…106 107## Orbit108 109Pluto's orbital period is about 248 years…110`111 112const file = await remark()113  .use(remarkToc, {heading: 'contents', tight: true})114  .process(doc)115 116console.error(String(file))117```118 119…running that with `node example.js` yields:120 121```markdown122# Pluto123 124Pluto is a dwarf planet in the Kuiper belt.125 126## Contents127 128* [History](#history)129  * [Discovery](#discovery)130  * [Name and symbol](#name-and-symbol)131  * [Planet X disproved](#planet-x-disproved)132* [Orbit](#orbit)133 134## History135 136### Discovery137 138In the 1840s, Urbain Le Verrier used Newtonian mechanics to predict the position of…139 140### Name and symbol141 142The name Pluto is for the Roman god of the underworld, from a Greek epithet for Hades…143 144### Planet X disproved145 146Once Pluto was found, its faintness and lack of a viewable disc cast doubt…147 148## Orbit149 150Pluto's orbital period is about 248 years…151```152 153## API154 155This package exports the identifier [`remark`][api-remark].156There is no default export.157 158### `remark()`159 160Create a new unified processor that already uses161[`remark-parse`][remark-parse] and [`remark-stringify`][remark-stringify].162 163You can add more plugins with `use`.164See [`unified`][unified] for more information.165 166## Examples167 168### Example: checking markdown169 170The following example checks that markdown code style is consistent and follows171some best practices:172 173```js174import {remark} from 'remark'175import remarkPresetLintConsistent from 'remark-preset-lint-consistent'176import remarkPresetLintRecommended from 'remark-preset-lint-recommended'177import {reporter} from 'vfile-reporter'178 179const file = await remark()180  .use(remarkPresetLintConsistent)181  .use(remarkPresetLintRecommended)182  .process('1) Hello, _Jupiter_ and *Neptune*!')183 184console.error(reporter(file))185```186 187Yields:188 189```txt190          warning Missing newline character at end of file final-newline             remark-lint1911:1-1:35  warning Marker style should be `.`               ordered-list-marker-style remark-lint1921:4       warning Incorrect list-item indent: add 1 space  list-item-indent          remark-lint1931:25-1:34 warning Emphasis should use `_` as a marker      emphasis-marker           remark-lint194 195⚠ 4 warnings196```197 198### Example: passing options to `remark-stringify`199 200When you use `remark-stringify` manually you can pass options to `use`.201Because `remark-stringify` is already used in `remark`, that’s not possible.202To define options for `remark-stringify`, you can instead pass options to203`data`:204 205```js206import {remark} from 'remark'207 208const doc = `209# Moons of Neptune210 2111. Naiad2122. Thalassa2133. Despine2144. …215`216 217const file = await remark()218  .data('settings', {219    bulletOrdered: ')',220    incrementListMarker: false,221    setext: true222  })223  .process(doc)224 225console.log(String(file))226```227 228Yields:229 230```markdown231Moons of Neptune232================233 2341) Naiad2351) Thalassa2361) Despine2371) …238```239 240## Syntax241 242Markdown is parsed and serialized according to CommonMark.243Other plugins can add support for syntax extensions.244 245## Syntax tree246 247The syntax tree used in remark is [mdast][].248 249## Types250 251This package is fully typed with [TypeScript][].252There are no extra exported types.253 254It also registers `Settings` with `unified`.255If you’re passing options with `.data('settings', …)`, make sure to import this256package somewhere in your types, as that registers the fields.257 258```js259/// <reference types="remark" />260 261import {unified} from 'unified'262 263// @ts-expect-error: `thisDoesNotExist` is not a valid option.264unified().data('settings', {thisDoesNotExist: false})265```266 267## Compatibility268 269Projects maintained by the unified collective are compatible with maintained270versions of Node.js.271 272When we cut a new major release, we drop support for unmaintained versions of273Node.274This means we try to keep the current release line, `remark@^15`, compatible275with Node.js 16.276 277## Security278 279As markdown can be turned into HTML and improper use of HTML can open you up to280[cross-site scripting (XSS)][xss] attacks, use of remark can be unsafe.281When going to HTML, you will combine remark with **[rehype][]**, in which case282you should use [`rehype-sanitize`][rehype-sanitize].283 284Use of remark plugins could also open you up to other attacks.285Carefully assess each plugin and the risks involved in using them.286 287For info on how to submit a report, see our [security policy][security].288 289## Contribute290 291See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways292to get started.293See [`support.md`][support] for ways to get help.294Join us in [Discussions][chat] to chat with the community and contributors.295 296This project has a [code of conduct][coc].297By interacting with this repository, organization, or community you agree to298abide by its terms.299 300## Sponsor301 302Support this effort and give back by sponsoring on [OpenCollective][collective]!303 304<table>305<tr valign="middle">306<td width="20%" align="center" rowspan="2" colspan="2">307  <a href="https://vercel.com">Vercel</a><br><br>308  <a href="https://vercel.com"><img src="https://avatars1.githubusercontent.com/u/14985020?s=256&v=4" width="128"></a>309</td>310<td width="20%" align="center" rowspan="2" colspan="2">311  <a href="https://motif.land">Motif</a><br><br>312  <a href="https://motif.land"><img src="https://avatars1.githubusercontent.com/u/74457950?s=256&v=4" width="128"></a>313</td>314<td width="20%" align="center" rowspan="2" colspan="2">315  <a href="https://www.hashicorp.com">HashiCorp</a><br><br>316  <a href="https://www.hashicorp.com"><img src="https://avatars1.githubusercontent.com/u/761456?s=256&v=4" width="128"></a>317</td>318<td width="20%" align="center" rowspan="2" colspan="2">319  <a href="https://www.gitbook.com">GitBook</a><br><br>320  <a href="https://www.gitbook.com"><img src="https://avatars1.githubusercontent.com/u/7111340?s=256&v=4" width="128"></a>321</td>322<td width="20%" align="center" rowspan="2" colspan="2">323  <a href="https://www.gatsbyjs.org">Gatsby</a><br><br>324  <a href="https://www.gatsbyjs.org"><img src="https://avatars1.githubusercontent.com/u/12551863?s=256&v=4" width="128"></a>325</td>326</tr>327<tr valign="middle">328</tr>329<tr valign="middle">330<td width="20%" align="center" rowspan="2" colspan="2">331  <a href="https://www.netlify.com">Netlify</a><br><br>332  <!--OC has a sharper image-->333  <a href="https://www.netlify.com"><img src="https://images.opencollective.com/netlify/4087de2/logo/256.png" width="128"></a>334</td>335<td width="10%" align="center">336  <a href="https://www.coinbase.com">Coinbase</a><br><br>337  <a href="https://www.coinbase.com"><img src="https://avatars1.githubusercontent.com/u/1885080?s=256&v=4" width="64"></a>338</td>339<td width="10%" align="center">340  <a href="https://themeisle.com">ThemeIsle</a><br><br>341  <a href="https://themeisle.com"><img src="https://avatars1.githubusercontent.com/u/58979018?s=128&v=4" width="64"></a>342</td>343<td width="10%" align="center">344  <a href="https://expo.io">Expo</a><br><br>345  <a href="https://expo.io"><img src="https://avatars1.githubusercontent.com/u/12504344?s=128&v=4" width="64"></a>346</td>347<td width="10%" align="center">348  <a href="https://boostnote.io">Boost Note</a><br><br>349  <a href="https://boostnote.io"><img src="https://images.opencollective.com/boosthub/6318083/logo/128.png" width="64"></a>350</td>351<td width="10%" align="center">352  <a href="https://markdown.space">Markdown Space</a><br><br>353  <a href="https://markdown.space"><img src="https://images.opencollective.com/markdown-space/e1038ed/logo/128.png" width="64"></a>354</td>355<td width="10%" align="center">356  <a href="https://www.holloway.com">Holloway</a><br><br>357  <a href="https://www.holloway.com"><img src="https://avatars1.githubusercontent.com/u/35904294?s=128&v=4" width="64"></a>358</td>359<td width="10%"></td>360<td width="10%"></td>361</tr>362<tr valign="middle">363<td width="100%" align="center" colspan="8">364  <br>365  <a href="https://opencollective.com/unified"><strong>You?</strong></a>366  <br><br>367</td>368</tr>369</table>370 371## License372 373[MIT][license] © [Titus Wormer][author]374 375<!-- Definitions -->376 377[build-badge]: https://github.com/remarkjs/remark/workflows/main/badge.svg378 379[build]: https://github.com/remarkjs/remark/actions380 381[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark.svg382 383[coverage]: https://codecov.io/github/remarkjs/remark384 385[downloads-badge]: https://img.shields.io/npm/dm/remark.svg386 387[downloads]: https://www.npmjs.com/package/remark388 389[size-badge]: https://img.shields.io/bundlejs/size/remark390 391[size]: https://bundlejs.com/?q=remark392 393[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg394 395[backers-badge]: https://opencollective.com/unified/backers/badge.svg396 397[collective]: https://opencollective.com/unified398 399[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg400 401[chat]: https://github.com/remarkjs/remark/discussions402 403[security]: https://github.com/remarkjs/.github/blob/main/security.md404 405[health]: https://github.com/remarkjs/.github406 407[contributing]: https://github.com/remarkjs/.github/blob/main/contributing.md408 409[support]: https://github.com/remarkjs/.github/blob/main/support.md410 411[coc]: https://github.com/remarkjs/.github/blob/main/code-of-conduct.md412 413[license]: https://github.com/remarkjs/remark/blob/main/license414 415[author]: https://wooorm.com416 417[npm]: https://docs.npmjs.com/cli/install418 419[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c420 421[esmsh]: https://esm.sh422 423[mdast]: https://github.com/syntax-tree/mdast424 425[rehype]: https://github.com/rehypejs/rehype426 427[rehype-sanitize]: https://github.com/rehypejs/rehype-sanitize428 429[remark]: https://github.com/remarkjs/remark430 431[remark-parse]: ../remark-parse432 433[remark-stringify]: ../remark-stringify434 435[remark-cli]: ../remark-cli436 437[typescript]: https://www.typescriptlang.org438 439[unified]: https://github.com/unifiedjs/unified440 441[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting442 443[api-remark]: #remark-1444