Brunobkr/llama.cpp_AlgMor24_github

1# remark-parse2 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 add support for parsing from markdown.12 13## Contents14 15*   [What is this?](#what-is-this)16*   [When should I use this?](#when-should-i-use-this)17*   [Install](#install)18*   [Use](#use)19*   [API](#api)20    *   [`unified().use(remarkParse)`](#unifieduseremarkparse)21*   [Examples](#examples)22    *   [Example: support GFM and frontmatter](#example-support-gfm-and-frontmatter)23    *   [Example: turning markdown into a man page](#example-turning-markdown-into-a-man-page)24*   [Syntax](#syntax)25*   [Syntax tree](#syntax-tree)26*   [Types](#types)27*   [Compatibility](#compatibility)28*   [Security](#security)29*   [Contribute](#contribute)30*   [Sponsor](#sponsor)31*   [License](#license)32 33## What is this?34 35This package is a [unified][] ([remark][]) plugin that defines how to take36markdown as input and turn it into a syntax tree.37 38See [the monorepo readme][remark] for info on what the remark ecosystem is.39 40## When should I use this?41 42This plugin adds support to unified for parsing markdown.43If you also need to serialize markdown, you can alternatively use44[`remark`][remark-core], which combines unified, this plugin, and45[`remark-stringify`][remark-stringify].46 47If you *just* want to turn markdown into HTML (with maybe a few extensions),48we recommend [`micromark`][micromark] instead.49If you don’t use plugins and want to access the syntax tree, you can directly50use [`mdast-util-from-markdown`][mdast-util-from-markdown].51remark focusses on making it easier to transform content by abstracting these52internals away.53 54You can combine this plugin with other plugins to add syntax extensions.55Notable examples that deeply integrate with it are56[`remark-gfm`][remark-gfm],57[`remark-mdx`][remark-mdx],58[`remark-frontmatter`][remark-frontmatter],59[`remark-math`][remark-math], and60[`remark-directive`][remark-directive].61You can also use any other [remark plugin][remark-plugin] after `remark-parse`.62 63## Install64 65This package is [ESM only][esm].66In Node.js (version 16+), install with [npm][]:67 68```sh69npm install remark-parse70```71 72In Deno with [`esm.sh`][esmsh]:73 74```js75import remarkParse from 'https://esm.sh/remark-parse@11'76```77 78In browsers with [`esm.sh`][esmsh]:79 80```html81<script type="module">82  import remarkParse from 'https://esm.sh/remark-parse@11?bundle'83</script>84```85 86## Use87 88Say we have the following module `example.js`:89 90```js91import rehypeStringify from 'rehype-stringify'92import remarkGfm from 'remark-gfm'93import remarkParse from 'remark-parse'94import remarkRehype from 'remark-rehype'95import {unified} from 'unified'96 97const doc = `98# Mercury99 100**Mercury** is the first planet from the [Sun](https://en.wikipedia.org/wiki/Sun)101and the smallest planet in the Solar System.102`103 104const file = await unified()105  .use(remarkParse)106  .use(remarkGfm)107  .use(remarkRehype)108  .use(rehypeStringify)109  .process(doc)110 111console.log(String(file))112```113 114…then running `node example.js` yields:115 116```html117<h1>Mercury</h1>118<p><strong>Mercury</strong> is the first planet from the <a href="https://en.wikipedia.org/wiki/Sun">Sun</a>119and the smallest planet in the Solar System.</p>120```121 122## API123 124This package exports no identifiers.125The default export is [`remarkParse`][api-remark-parse].126 127### `unified().use(remarkParse)`128 129Add support for parsing from markdown.130 131###### Parameters132 133There are no parameters.134 135###### Returns136 137Nothing (`undefined`).138 139## Examples140 141### Example: support GFM and frontmatter142 143We support CommonMark by default.144Non-standard markdown extensions can be enabled with plugins.145 146This example shows how to support GFM features (autolink literals,147footnotes, strikethrough, tables, tasklists) and frontmatter (YAML):148 149```js150import rehypeStringify from 'rehype-stringify'151import remarkFrontmatter from 'remark-frontmatter'152import remarkGfm from 'remark-gfm'153import remarkParse from 'remark-parse'154import remarkRehype from 'remark-rehype'155import {unified} from 'unified'156 157const doc = `---158layout: solar-system159---160 161# Hi ~~Mars~~Venus!162`163 164const file = await unified()165  .use(remarkParse)166  .use(remarkFrontmatter)167  .use(remarkGfm)168  .use(remarkRehype)169  .use(rehypeStringify)170  .process(doc)171 172console.log(String(file))173```174 175Yields:176 177```html178<h1>Hi <del>Mars</del>Venus!</h1>179```180 181### Example: turning markdown into a man page182 183Man pages (short for manual pages) are a way to document CLIs (example: type184`man git-log` in your terminal).185They use an old markup format called roff.186There’s a remark plugin, [`remark-man`][remark-man], that can serialize as187roff.188 189This example shows how to turn markdown into man pages by using unified with190`remark-parse` and `remark-man`:191 192```js193import remarkMan from 'remark-man'194import remarkParse from 'remark-parse'195import {unified} from 'unified'196 197const doc = `198# titan(7) -- largest moon of saturn199 200Titan is the largest moon…201`202 203const file = await unified().use(remarkParse).use(remarkMan).process(doc)204 205console.log(String(file))206```207 208Yields:209 210```roff211.TH "TITAN" "7" "September 2023" "" ""212.SH "NAME"213\fBtitan\fR - largest moon of saturn214.P215Titan is the largest moon…216```217 218## Syntax219 220Markdown is parsed according to CommonMark.221Other plugins can add support for syntax extensions.222If you’re interested in extending markdown,223[more information is available in micromark’s readme][micromark-extend].224 225## Syntax tree226 227The syntax tree used in remark is [mdast][].228 229## Types230 231This package is fully typed with [TypeScript][].232It exports the additional type `Options` (which is currently empty).233 234## Compatibility235 236Projects maintained by the unified collective are compatible with maintained237versions of Node.js.238 239When we cut a new major release, we drop support for unmaintained versions of240Node.241This means we try to keep the current release line, `remark-parse@^11`,242compatible with Node.js 16.243 244## Security245 246As markdown can be turned into HTML and improper use of HTML can open you up to247[cross-site scripting (XSS)][xss] attacks, use of remark can be unsafe.248When going to HTML, you will combine remark with **[rehype][]**, in which case249you should use [`rehype-sanitize`][rehype-sanitize].250 251Use of remark plugins could also open you up to other attacks.252Carefully assess each plugin and the risks involved in using them.253 254For info on how to submit a report, see our [security policy][security].255 256## Contribute257 258See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways259to get started.260See [`support.md`][support] for ways to get help.261Join us in [Discussions][chat] to chat with the community and contributors.262 263This project has a [code of conduct][coc].264By interacting with this repository, organization, or community you agree to265abide by its terms.266 267## Sponsor268 269Support this effort and give back by sponsoring on [OpenCollective][collective]!270 271<table>272<tr valign="middle">273<td width="20%" align="center" rowspan="2" colspan="2">274  <a href="https://vercel.com">Vercel</a><br><br>275  <a href="https://vercel.com"><img src="https://avatars1.githubusercontent.com/u/14985020?s=256&v=4" width="128"></a>276</td>277<td width="20%" align="center" rowspan="2" colspan="2">278  <a href="https://motif.land">Motif</a><br><br>279  <a href="https://motif.land"><img src="https://avatars1.githubusercontent.com/u/74457950?s=256&v=4" width="128"></a>280</td>281<td width="20%" align="center" rowspan="2" colspan="2">282  <a href="https://www.hashicorp.com">HashiCorp</a><br><br>283  <a href="https://www.hashicorp.com"><img src="https://avatars1.githubusercontent.com/u/761456?s=256&v=4" width="128"></a>284</td>285<td width="20%" align="center" rowspan="2" colspan="2">286  <a href="https://www.gitbook.com">GitBook</a><br><br>287  <a href="https://www.gitbook.com"><img src="https://avatars1.githubusercontent.com/u/7111340?s=256&v=4" width="128"></a>288</td>289<td width="20%" align="center" rowspan="2" colspan="2">290  <a href="https://www.gatsbyjs.org">Gatsby</a><br><br>291  <a href="https://www.gatsbyjs.org"><img src="https://avatars1.githubusercontent.com/u/12551863?s=256&v=4" width="128"></a>292</td>293</tr>294<tr valign="middle">295</tr>296<tr valign="middle">297<td width="20%" align="center" rowspan="2" colspan="2">298  <a href="https://www.netlify.com">Netlify</a><br><br>299  <!--OC has a sharper image-->300  <a href="https://www.netlify.com"><img src="https://images.opencollective.com/netlify/4087de2/logo/256.png" width="128"></a>301</td>302<td width="10%" align="center">303  <a href="https://www.coinbase.com">Coinbase</a><br><br>304  <a href="https://www.coinbase.com"><img src="https://avatars1.githubusercontent.com/u/1885080?s=256&v=4" width="64"></a>305</td>306<td width="10%" align="center">307  <a href="https://themeisle.com">ThemeIsle</a><br><br>308  <a href="https://themeisle.com"><img src="https://avatars1.githubusercontent.com/u/58979018?s=128&v=4" width="64"></a>309</td>310<td width="10%" align="center">311  <a href="https://expo.io">Expo</a><br><br>312  <a href="https://expo.io"><img src="https://avatars1.githubusercontent.com/u/12504344?s=128&v=4" width="64"></a>313</td>314<td width="10%" align="center">315  <a href="https://boostnote.io">Boost Note</a><br><br>316  <a href="https://boostnote.io"><img src="https://images.opencollective.com/boosthub/6318083/logo/128.png" width="64"></a>317</td>318<td width="10%" align="center">319  <a href="https://markdown.space">Markdown Space</a><br><br>320  <a href="https://markdown.space"><img src="https://images.opencollective.com/markdown-space/e1038ed/logo/128.png" width="64"></a>321</td>322<td width="10%" align="center">323  <a href="https://www.holloway.com">Holloway</a><br><br>324  <a href="https://www.holloway.com"><img src="https://avatars1.githubusercontent.com/u/35904294?s=128&v=4" width="64"></a>325</td>326<td width="10%"></td>327<td width="10%"></td>328</tr>329<tr valign="middle">330<td width="100%" align="center" colspan="8">331  <br>332  <a href="https://opencollective.com/unified"><strong>You?</strong></a>333  <br><br>334</td>335</tr>336</table>337 338## License339 340[MIT][license] © [Titus Wormer][author]341 342<!-- Definitions -->343 344[build-badge]: https://github.com/remarkjs/remark/workflows/main/badge.svg345 346[build]: https://github.com/remarkjs/remark/actions347 348[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark.svg349 350[coverage]: https://codecov.io/github/remarkjs/remark351 352[downloads-badge]: https://img.shields.io/npm/dm/remark-parse.svg353 354[downloads]: https://www.npmjs.com/package/remark-parse355 356[size-badge]: https://img.shields.io/bundlejs/size/remark-parse357 358[size]: https://bundlejs.com/?q=remark-parse359 360[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg361 362[backers-badge]: https://opencollective.com/unified/backers/badge.svg363 364[collective]: https://opencollective.com/unified365 366[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg367 368[chat]: https://github.com/remarkjs/remark/discussions369 370[security]: https://github.com/remarkjs/.github/blob/main/security.md371 372[health]: https://github.com/remarkjs/.github373 374[contributing]: https://github.com/remarkjs/.github/blob/main/contributing.md375 376[support]: https://github.com/remarkjs/.github/blob/main/support.md377 378[coc]: https://github.com/remarkjs/.github/blob/main/code-of-conduct.md379 380[license]: https://github.com/remarkjs/remark/blob/main/license381 382[author]: https://wooorm.com383 384[npm]: https://docs.npmjs.com/cli/install385 386[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c387 388[esmsh]: https://esm.sh389 390[mdast]: https://github.com/syntax-tree/mdast391 392[mdast-util-from-markdown]: https://github.com/syntax-tree/mdast-util-from-markdown393 394[micromark]: https://github.com/micromark/micromark395 396[micromark-extend]: https://github.com/micromark/micromark#extensions397 398[rehype]: https://github.com/rehypejs/rehype399 400[rehype-sanitize]: https://github.com/rehypejs/rehype-sanitize401 402[remark]: https://github.com/remarkjs/remark403 404[remark-core]: ../remark/405 406[remark-directive]: https://github.com/remarkjs/remark-directive407 408[remark-frontmatter]: https://github.com/remarkjs/remark-frontmatter409 410[remark-gfm]: https://github.com/remarkjs/remark-gfm411 412[remark-mdx]: https://github.com/mdx-js/mdx/tree/main/packages/remark-mdx413 414[remark-man]: https://github.com/remarkjs/remark-man415 416[remark-math]: https://github.com/remarkjs/remark-math417 418[remark-plugin]: https://github.com/remarkjs/remark#plugin419 420[remark-stringify]: ../remark-stringify/421 422[typescript]: https://www.typescriptlang.org423 424[unified]: https://github.com/unifiedjs/unified425 426[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting427 428[api-remark-parse]: #unifieduseremarkparse429