Brunobkr/llama.cpp_AlgMor24_github

1# remark-stringify2 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 serializing to 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(remarkStringify[, options])`](#unifieduseremarkstringify-options)21*   [Syntax](#syntax)22*   [Syntax tree](#syntax-tree)23*   [Types](#types)24*   [Security](#security)25*   [Contribute](#contribute)26*   [Sponsor](#sponsor)27*   [License](#license)28 29## What is this?30 31This package is a [unified][] ([remark][]) plugin that defines how to take a32syntax tree as input and turn it into serialized markdown.33When it’s used, markdown is serialized as the final result.34 35See [the monorepo readme][remark] for info on what the remark ecosystem is.36 37## When should I use this?38 39This plugin adds support to unified for serializing markdown.40If you also need to parse markdown, you can alternatively use41[`remark`][remark-core], which combines unified,42[`remark-parse`][remark-parse], and this plugin.43 44If you don’t use plugins and have access to a syntax tree, you can directly use45[`mdast-util-to-markdown`][mdast-util-to-markdown], which is used inside this46plugin.47remark focusses on making it easier to transform content by abstracting these48internals away.49 50You can combine this plugin with other plugins to add syntax extensions.51Notable examples that deeply integrate with it are52[`remark-gfm`][remark-gfm],53[`remark-mdx`][remark-mdx],54[`remark-frontmatter`][remark-frontmatter],55[`remark-math`][remark-math], and56[`remark-directive`][remark-directive].57You can also use any other [remark plugin][remark-plugin] before58`remark-stringify`.59 60## Install61 62This package is [ESM only][esm].63In Node.js (version 16+), install with [npm][]:64 65```sh66npm install remark-stringify67```68 69In Deno with [`esm.sh`][esmsh]:70 71```js72import remarkStringify from 'https://esm.sh/remark-stringify@11'73```74 75In browsers with [`esm.sh`][esmsh]:76 77```html78<script type="module">79  import remarkStringify from 'https://esm.sh/remark-stringify@11?bundle'80</script>81```82 83## Use84 85Say we have the following module `example.js`:86 87```js88import rehypeParse from 'rehype-parse'89import rehypeRemark from 'rehype-remark'90import remarkStringify from 'remark-stringify'91import {unified} from 'unified'92 93const doc = `94<h1>Uranus</h1>95<p><b>Uranus</b> is the seventh96<a href="/wiki/Planet" title="Planet">planet</a> from the Sun and is a gaseous97cyan <a href="/wiki/Ice_giant" title="Ice giant">ice giant</a>.</p>98`99 100const file = await unified()101  .use(rehypeParse)102  .use(rehypeRemark)103  .use(remarkStringify)104  .process(doc)105 106console.log(String(file))107```108 109…then running `node example.js` yields:110 111```markdown112# Uranus113 114**Uranus** is the seventh [planet](/wiki/Planet "Planet") from the Sun and is a gaseous cyan [ice giant](/wiki/Ice_giant "Ice giant").115```116 117## API118 119This package exports no identifiers.120The default export is [`remarkStringify`][api-remark-stringify].121 122### `unified().use(remarkStringify[, options])`123 124Add support for serializing to markdown.125 126###### Parameters127 128*   `options` ([`Options`][api-options], optional)129    — configuration130 131###### Returns132 133Nothing (`undefined`).134 135### `Options`136 137Configuration (TypeScript type).138 139###### Fields140 141*   `bullet` (`'*'`, `'+'`, or `'-'`, default: `'*'`)142    — marker to use for bullets of items in unordered lists143*   `bulletOther` (`'*'`, `'+'`, or `'-'`, default: `'-'` when `bullet` is144    `'*'`, `'*'` otherwise)145    — marker to use in certain cases where the primary bullet doesn’t work;146    cannot be equal to `bullet`147*   `bulletOrdered` (`'.'` or `')'`, default: `'.'`)148    — marker to use for bullets of items in ordered lists149*   `closeAtx` (`boolean`, default: `false`)150    — add the same number of number signs (`#`) at the end of an ATX heading as151    the opening sequence152*   `emphasis` (`'*'` or `'_'`, default: `'*'`)153    — marker to use for emphasis154*   `fence` (``'`'`` or `'~'`, default: ``'`'``)155    — marker to use for fenced code156*   `fences` (`boolean`, default: `true`)157    — use fenced code always; when `false`, uses fenced code if there is a158    language defined, if the code is empty, or if it starts or ends in blank159    lines160*   `handlers` (`Handlers`, optional)161    — handle particular nodes;162    see [`mdast-util-to-markdown`][mdast-util-to-markdown] for more info163*   `incrementListMarker` (`boolean`, default: `true`)164    — increment the counter of ordered lists items165*   `join` (`Array<Join>`, optional)166    — how to join blocks;167    see [`mdast-util-to-markdown`][mdast-util-to-markdown] for more info168*   `listItemIndent` (`'mixed'`, `'one'`, or `'tab'`, default: `'one'`)169    — how to indent the content of list items;170    either with the size of the bullet plus one space (when `'one'`), a tab171    stop (`'tab'`), or depending on the item and its parent list: `'mixed'`172    uses `'one'` if the item and list are tight and `'tab'` otherwise173*   `quote` (`'"'` or `"'"`, default: `'"'`)174    — marker to use for titles175*   `resourceLink` (`boolean`, default: `false`)176    — always use resource links (`[text](url)`);177    when `false`, uses autolinks (`<https://example.com>`) when possible178*   `rule` (`'*'`, `'-'`, or `'_'`, default: `'*'`)179    — marker to use for thematic breaks180*   `ruleRepetition` (`number`, default: `3`, min: `3`)181    — number of markers to use for thematic breaks182*   `ruleSpaces` (`boolean`, default: `false`)183    — add spaces between markers in thematic breaks184*   `setext` (`boolean`, default: `false`)185    — use setext headings when possible;186    when `true`, uses setext headings (`heading\n=======`) for non-empty rank 1187    or 2 headings188*   `strong` (`'*'` or `'_'`, default: `'*'`)189    — marker to use for strong190*   `tightDefinitions` (`boolean`, default: `false`)191    — join definitions without a blank line192*   `unsafe` (`Array<Unsafe>`, optional)193    — schemas that define when characters cannot occur;194    see [`mdast-util-to-markdown`][mdast-util-to-markdown] for more info195 196<!-- Note: `extensions` intentionally not supported/documented. -->197 198## Syntax199 200Markdown is serialized according to CommonMark but care is taken to format in a201way that works with most markdown parsers.202Other plugins can add support for syntax extensions.203 204## Syntax tree205 206The syntax tree used in remark is [mdast][].207 208## Types209 210This package is fully typed with [TypeScript][].211It exports the additional type [`Options`][api-options].212 213It also registers `Settings` with `unified`.214If you’re passing options with `.data('settings', …)`, make sure to import this215package somewhere in your types, as that registers the fields.216 217```js218/// <reference types="remark-stringify" />219 220import {unified} from 'unified'221 222// @ts-expect-error: `thisDoesNotExist` is not a valid option.223unified().data('settings', {thisDoesNotExist: false})224```225 226## Compatibility227 228Projects maintained by the unified collective are compatible with maintained229versions of Node.js.230 231When we cut a new major release, we drop support for unmaintained versions of232Node.233This means we try to keep the current release line, `remark-stringify@^11`,234compatible with Node.js 16.235 236## Security237 238Use of `remark-stringify` is safe.239 240Use of remark plugins can open you up to attacks.241Carefully assess each plugin and the risks involved in using them.242 243For info on how to submit a report, see our [security policy][security].244 245## Contribute246 247See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways248to get started.249See [`support.md`][support] for ways to get help.250Join us in [Discussions][chat] to chat with the community and contributors.251 252This project has a [code of conduct][coc].253By interacting with this repository, organization, or community you agree to254abide by its terms.255 256## Sponsor257 258Support this effort and give back by sponsoring on [OpenCollective][collective]!259 260<table>261<tr valign="middle">262<td width="20%" align="center" rowspan="2" colspan="2">263  <a href="https://vercel.com">Vercel</a><br><br>264  <a href="https://vercel.com"><img src="https://avatars1.githubusercontent.com/u/14985020?s=256&v=4" width="128"></a>265</td>266<td width="20%" align="center" rowspan="2" colspan="2">267  <a href="https://motif.land">Motif</a><br><br>268  <a href="https://motif.land"><img src="https://avatars1.githubusercontent.com/u/74457950?s=256&v=4" width="128"></a>269</td>270<td width="20%" align="center" rowspan="2" colspan="2">271  <a href="https://www.hashicorp.com">HashiCorp</a><br><br>272  <a href="https://www.hashicorp.com"><img src="https://avatars1.githubusercontent.com/u/761456?s=256&v=4" width="128"></a>273</td>274<td width="20%" align="center" rowspan="2" colspan="2">275  <a href="https://www.gitbook.com">GitBook</a><br><br>276  <a href="https://www.gitbook.com"><img src="https://avatars1.githubusercontent.com/u/7111340?s=256&v=4" width="128"></a>277</td>278<td width="20%" align="center" rowspan="2" colspan="2">279  <a href="https://www.gatsbyjs.org">Gatsby</a><br><br>280  <a href="https://www.gatsbyjs.org"><img src="https://avatars1.githubusercontent.com/u/12551863?s=256&v=4" width="128"></a>281</td>282</tr>283<tr valign="middle">284</tr>285<tr valign="middle">286<td width="20%" align="center" rowspan="2" colspan="2">287  <a href="https://www.netlify.com">Netlify</a><br><br>288  <!--OC has a sharper image-->289  <a href="https://www.netlify.com"><img src="https://images.opencollective.com/netlify/4087de2/logo/256.png" width="128"></a>290</td>291<td width="10%" align="center">292  <a href="https://www.coinbase.com">Coinbase</a><br><br>293  <a href="https://www.coinbase.com"><img src="https://avatars1.githubusercontent.com/u/1885080?s=256&v=4" width="64"></a>294</td>295<td width="10%" align="center">296  <a href="https://themeisle.com">ThemeIsle</a><br><br>297  <a href="https://themeisle.com"><img src="https://avatars1.githubusercontent.com/u/58979018?s=128&v=4" width="64"></a>298</td>299<td width="10%" align="center">300  <a href="https://expo.io">Expo</a><br><br>301  <a href="https://expo.io"><img src="https://avatars1.githubusercontent.com/u/12504344?s=128&v=4" width="64"></a>302</td>303<td width="10%" align="center">304  <a href="https://boostnote.io">Boost Note</a><br><br>305  <a href="https://boostnote.io"><img src="https://images.opencollective.com/boosthub/6318083/logo/128.png" width="64"></a>306</td>307<td width="10%" align="center">308  <a href="https://markdown.space">Markdown Space</a><br><br>309  <a href="https://markdown.space"><img src="https://images.opencollective.com/markdown-space/e1038ed/logo/128.png" width="64"></a>310</td>311<td width="10%" align="center">312  <a href="https://www.holloway.com">Holloway</a><br><br>313  <a href="https://www.holloway.com"><img src="https://avatars1.githubusercontent.com/u/35904294?s=128&v=4" width="64"></a>314</td>315<td width="10%"></td>316<td width="10%"></td>317</tr>318<tr valign="middle">319<td width="100%" align="center" colspan="8">320  <br>321  <a href="https://opencollective.com/unified"><strong>You?</strong></a>322  <br><br>323</td>324</tr>325</table>326 327## License328 329[MIT][license] © [Titus Wormer][author]330 331<!-- Definitions -->332 333[build-badge]: https://github.com/remarkjs/remark/workflows/main/badge.svg334 335[build]: https://github.com/remarkjs/remark/actions336 337[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark.svg338 339[coverage]: https://codecov.io/github/remarkjs/remark340 341[downloads-badge]: https://img.shields.io/npm/dm/remark-stringify.svg342 343[downloads]: https://www.npmjs.com/package/remark-stringify344 345[size-badge]: https://img.shields.io/bundlejs/size/remark-stringify346 347[size]: https://bundlejs.com/?q=remark-stringify348 349[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg350 351[backers-badge]: https://opencollective.com/unified/backers/badge.svg352 353[collective]: https://opencollective.com/unified354 355[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg356 357[chat]: https://github.com/remarkjs/remark/discussions358 359[security]: https://github.com/remarkjs/.github/blob/main/security.md360 361[health]: https://github.com/remarkjs/.github362 363[contributing]: https://github.com/remarkjs/.github/blob/main/contributing.md364 365[support]: https://github.com/remarkjs/.github/blob/main/support.md366 367[coc]: https://github.com/remarkjs/.github/blob/main/code-of-conduct.md368 369[license]: https://github.com/remarkjs/remark/blob/main/license370 371[author]: https://wooorm.com372 373[npm]: https://docs.npmjs.com/cli/install374 375[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c376 377[esmsh]: https://esm.sh378 379[mdast]: https://github.com/syntax-tree/mdast380 381[mdast-util-to-markdown]: https://github.com/syntax-tree/mdast-util-to-markdown382 383[remark]: https://github.com/remarkjs/remark384 385[remark-core]: ../remark/386 387[remark-directive]: https://github.com/remarkjs/remark-directive388 389[remark-frontmatter]: https://github.com/remarkjs/remark-frontmatter390 391[remark-gfm]: https://github.com/remarkjs/remark-gfm392 393[remark-math]: https://github.com/remarkjs/remark-math394 395[remark-mdx]: https://github.com/mdx-js/mdx/tree/main/packages/remark-mdx396 397[remark-parse]: ../remark-parse/398 399[remark-plugin]: https://github.com/remarkjs/remark#plugin400 401[typescript]: https://www.typescriptlang.org402 403[unified]: https://github.com/unifiedjs/unified404 405[api-options]: #options406 407[api-remark-stringify]: #unifieduseremarkstringify-options408