Brunobkr/llama.cpp_AlgMor24_github

1# micromark2 3[![Build][build-badge]][build]4[![Coverage][coverage-badge]][coverage]5[![Downloads][downloads-badge]][downloads]6[![Size][bundle-size-badge]][bundle-size]7[![Sponsors][sponsors-badge]][opencollective]8[![Backers][backers-badge]][opencollective]9[![Chat][chat-badge]][chat]10 11Markdown parser.12 13> **Note**: this is the `micromark` package from the micromark monorepo.14> See the [monorepo readme][micromark] for more on the project.15> See this readme for how to use it.16 17## Feature highlights18 19<!-- Note: this section has to be in sync with the monorepo readme. -->20 21* [x] **[compliant][commonmark]** (100% to CommonMark)22* [x] **[extensions][]** (100% [GFM][], 100% [MDX.js][mdxjs], [directives][],23  [frontmatter][], [math][])24* [x] **[safe][security]** (by default)25* [x] **[robust][test]** (±2k tests, 100% coverage, fuzz testing)26* [x] **[small][size-debug]** (smallest CM parser at ±14kb)27 28## Contents29 30* [When should I use this?](#when-should-i-use-this)31* [What is this?](#what-is-this)32* [Install](#install)33* [Use](#use)34* [API](#api)35  * [`micromark(value[, encoding][, options])`](#micromarkvalue-encoding-options)36  * [`stream(options?)`](#streamoptions)37  * [`Options`](#options)38* [Types](#types)39* [Compatibility](#compatibility)40* [Security](#security)41* [Contribute](#contribute)42* [Sponsor](#sponsor)43* [License](#license)44 45## When should I use this?46 47<!-- Note: this section has to be in sync with the monorepo readme. -->48 49* If you *just* want to turn markdown into HTML (with maybe a few extensions)50* If you want to do *really complex things* with markdown51 52See [§ Comparison][comparison] for more info53 54## What is this?55 56<!-- Note: this section has to be in sync with the monorepo readme. -->57 58`micromark` is an open source markdown parser written in JavaScript.59It’s implemented as a state machine that emits concrete tokens, so that every60byte is accounted for, with positional info.61It then compiles those tokens directly to HTML, but other tools can take the62data and for example build an AST which is easier to work with63([`mdast-util-to-markdown`][mdast-util-to-markdown]).64 65While most markdown parsers work towards compliancy with CommonMark (or GFM),66this project goes further by following how the reference parsers (`cmark`,67`cmark-gfm`) work, which is confirmed with thousands of extra tests.68 69Other than CommonMark and GFM, micromark also supports common extensions to70markdown such as MDX, math, and frontmatter.71 72These npm packages have a sibling project in Rust:73[`markdown-rs`][markdown-rs].74 75* to learn markdown, see this [cheatsheet and tutorial][cheat]76* for more about us, see [`unifiedjs.com`][site]77* for questions, see [Discussions][chat]78* to help, see [contribute][] and [sponsor][] below79 80## Install81 82<!-- Note: this section has to be in sync with the monorepo readme. -->83 84This package is [ESM only][esm].85In Node.js (version 16+), install with [npm][]:86 87```sh88npm install micromark89```90 91In Deno with [`esm.sh`][esmsh]:92 93```js94import {micromark} from 'https://esm.sh/micromark@3'95```96 97In browsers with [`esm.sh`][esmsh]:98 99```html100<script type="module">101  import {micromark} from 'https://esm.sh/micromark@3?bundle'102</script>103```104 105## Use106 107<!-- Note: this section has to be in sync with the `micromark` readme. -->108 109Typical use (buffering):110 111```js112import {micromark} from 'micromark'113 114console.log(micromark('## Hello, *world*!'))115```116 117Yields:118 119```html120<h2>Hello, <em>world</em>!</h2>121```122 123You can pass extensions (in this case [`micromark-extension-gfm`][gfm]):124 125```js126import {micromark} from 'micromark'127import {gfmHtml, gfm} from 'micromark-extension-gfm'128 129const value = '* [x] contact@example.com ~~strikethrough~~'130 131const result = micromark(value, {132  extensions: [gfm()],133  htmlExtensions: [gfmHtml()]134})135 136console.log(result)137```138 139Yields:140 141```html142<ul>143<li><input checked="" disabled="" type="checkbox"> <a href="mailto:contact@example.com">contact@example.com</a> <del>strikethrough</del></li>144</ul>145```146 147Streaming interface:148 149```js150import {createReadStream} from 'node:fs'151import {stream} from 'micromark/stream'152 153createReadStream('example.md')154  .on('error', handleError)155  .pipe(stream())156  .pipe(process.stdout)157 158function handleError(error) {159  // Handle your error here!160  throw error161}162```163 164## API165 166`micromark` core has two entries in its export map: `micromark` and167`micromark/stream`.168 169`micromark` exports the identifier [`micromark`][api-micromark].170`micromark/stream` exports the identifier [`stream`][api-stream].171There are no default exports.172 173The export map supports the [`development` condition][development].174Run `node --conditions development module.js` to get instrumented dev code.175Without this condition, production code is loaded.176See [§ Size & debug][size-debug] for more info.177 178### `micromark(value[, encoding][, options])`179 180Compile markdown to HTML.181 182> Note: which encodings are supported depends on the engine.183> For info on Node.js, see *[WHATWG supported encodings][encoding]*.184 185###### Parameters186 187* `value` (`string` or [`Uint8Array`][uint8-array])188  — markdown to parse189* `encoding` (`string`, default: `'utf8'`)190  — [character encoding][encoding] to understand `value` as when it’s a191  [`Uint8Array`][uint8-array]192* `options` ([`Options`][api-options], optional)193  — configuration194 195###### Returns196 197Compiled HTML (`string`).198 199### `stream(options?)`200 201Create a duplex (readable and writable) stream.202 203Some of the work to parse markdown can be done streaming, but in the204end buffering is required.205 206micromark does not handle errors for you, so you must handle errors on whatever207streams you pipe into it.208As markdown does not know errors, `micromark` itself does not emit errors.209 210###### Parameters211 212* `options` ([`Options`][api-options], optional)213  — configuration214 215###### Returns216 217Duplex stream.218 219### `Options`220 221Configuration (TypeScript type).222 223##### Fields224 225###### `allowDangerousHtml`226 227Whether to allow (dangerous) HTML (`boolean`, default: `false`).228 229The default is `false`, which still parses the HTML according to `CommonMark`230but shows the HTML as text instead of as elements.231 232Pass `true` for trusted content to get actual HTML elements.233See [§ Security][security].234 235###### `allowDangerousProtocol`236 237Whether to allow dangerous protocols in links and images (`boolean`, default:238`false`).239 240The default is `false`, which drops URLs in links and images that use dangerous241protocols.242 243Pass `true` for trusted content to support all protocols.244 245URLs that have no protocol (which means it’s relative to the current page, such246as `./some/page.html`) and URLs that have a safe protocol (for images: `http`,247`https`; for links: `http`, `https`, `irc`, `ircs`, `mailto`, `xmpp`), are248safe.249All other URLs are dangerous and dropped.250See [§ Security][security].251 252###### `defaultLineEnding`253 254Default line ending to use when compiling to HTML, for line endings not in255`value` (`'\r'`, `'\n'`, or `'\r\n'`; default: first line ending or `'\n'`).256 257Generally, `micromark` copies line endings (`\r`, `\n`, `\r\n`) in the markdown258document over to the compiled HTML.259In some cases, such as `> a`, CommonMark requires that extra line endings are260added: `<blockquote>\n<p>a</p>\n</blockquote>`.261 262To create that line ending, the document is checked for the first line ending263that is used.264If there is no line ending, `defaultLineEnding` is used.265If that isn’t configured, `\n` is used.266 267###### `extensions`268 269Array of syntax extensions (`Array<SyntaxExtension>`, default: `[]`).270See [§ Extensions][extensions].271 272###### `htmlExtensions`273 274Array of syntax extensions (`Array<HtmlExtension>`, default: `[]`).275See [§ Extensions][extensions].276 277## Types278 279This package is fully typed with [TypeScript][].280It exports the additional type [`Options`][api-options].281 282## Compatibility283 284Projects maintained by the unified collective are compatible with maintained285versions of Node.js.286 287When we cut a new major release, we drop support for unmaintained versions of288Node.289This means we try to keep the current release line, `micromark@4`, compatible290with Node.js 16.291 292## Security293 294This package is safe.295See [`security.md`][securitymd] in [`micromark/.github`][health] for how to296submit a security report.297 298## Contribute299 300See [`contributing.md`][contributing] in [`micromark/.github`][health] for ways301to get started.302See [`support.md`][support] for ways to get help.303 304This project has a [code of conduct][coc].305By interacting with this repository, organisation, or community you agree to306abide by its terms.307 308## Sponsor309 310<!-- Note: this section has to be in sync with the monorepo readme. -->311 312Support this effort and give back by sponsoring on [OpenCollective][]!313 314<table>315<tr valign="middle">316<td width="100%" align="center" colspan="10">317  <br>318  <a href="https://www.salesforce.com">Salesforce</a> 🏅<br><br>319  <a href="https://www.salesforce.com"><img src="https://images.opencollective.com/salesforce/ca8f997/logo/512.png" width="256"></a>320</td>321</tr>322<tr valign="middle">323<td width="20%" align="center" rowspan="2" colspan="2">324  <a href="https://vercel.com">Vercel</a><br><br>325  <a href="https://vercel.com"><img src="https://avatars1.githubusercontent.com/u/14985020?s=256&v=4" width="128"></a>326</td>327<td width="20%" align="center" rowspan="2" colspan="2">328  <a href="https://motif.land">Motif</a><br><br>329  <a href="https://motif.land"><img src="https://avatars1.githubusercontent.com/u/74457950?s=256&v=4" width="128"></a>330</td>331<td width="20%" align="center" rowspan="2" colspan="2">332  <a href="https://www.hashicorp.com">HashiCorp</a><br><br>333  <a href="https://www.hashicorp.com"><img src="https://avatars1.githubusercontent.com/u/761456?s=256&v=4" width="128"></a>334</td>335<td width="20%" align="center" rowspan="2" colspan="2">336  <a href="https://www.gitbook.com">GitBook</a><br><br>337  <a href="https://www.gitbook.com"><img src="https://avatars1.githubusercontent.com/u/7111340?s=256&v=4" width="128"></a>338</td>339<td width="20%" align="center" rowspan="2" colspan="2">340  <a href="https://www.gatsbyjs.org">Gatsby</a><br><br>341  <a href="https://www.gatsbyjs.org"><img src="https://avatars1.githubusercontent.com/u/12551863?s=256&v=4" width="128"></a>342</td>343</tr>344<tr valign="middle">345</tr>346<tr valign="middle">347<td width="20%" align="center" rowspan="2" colspan="2">348  <a href="https://www.netlify.com">Netlify</a><br><br>349  <!--OC has a sharper image-->350  <a href="https://www.netlify.com"><img src="https://images.opencollective.com/netlify/4087de2/logo/256.png" width="128"></a>351</td>352<td width="10%" align="center">353  <a href="https://www.coinbase.com">Coinbase</a><br><br>354  <a href="https://www.coinbase.com"><img src="https://avatars1.githubusercontent.com/u/1885080?s=256&v=4" width="64"></a>355</td>356<td width="10%" align="center">357  <a href="https://themeisle.com">ThemeIsle</a><br><br>358  <a href="https://themeisle.com"><img src="https://avatars1.githubusercontent.com/u/58979018?s=128&v=4" width="64"></a>359</td>360<td width="10%" align="center">361  <a href="https://expo.io">Expo</a><br><br>362  <a href="https://expo.io"><img src="https://avatars1.githubusercontent.com/u/12504344?s=128&v=4" width="64"></a>363</td>364<td width="10%" align="center">365  <a href="https://boostnote.io">Boost Note</a><br><br>366  <a href="https://boostnote.io"><img src="https://images.opencollective.com/boosthub/6318083/logo/128.png" width="64"></a>367</td>368<td width="10%" align="center">369  <a href="https://markdown.space">Markdown Space</a><br><br>370  <a href="https://markdown.space"><img src="https://images.opencollective.com/markdown-space/e1038ed/logo/128.png" width="64"></a>371</td>372<td width="10%" align="center">373  <a href="https://www.holloway.com">Holloway</a><br><br>374  <a href="https://www.holloway.com"><img src="https://avatars1.githubusercontent.com/u/35904294?s=128&v=4" width="64"></a>375</td>376<td width="10%"></td>377<td width="10%"></td>378</tr>379<tr valign="middle">380<td width="100%" align="center" colspan="8">381  <br>382  <a href="https://opencollective.com/unified"><strong>You?</strong></a>383  <br><br>384</td>385</tr>386</table>387 388## License389 390[MIT][license] © [Titus Wormer][author]391 392<!-- Definitions -->393 394[api-micromark]: #micromarkvalue-encoding-options395 396[api-options]: #options397 398[api-stream]: #streamoptions399 400[author]: https://wooorm.com401 402[backers-badge]: https://opencollective.com/unified/backers/badge.svg403 404[build]: https://github.com/micromark/micromark/actions405 406[build-badge]: https://github.com/micromark/micromark/workflows/main/badge.svg407 408[bundle-size]: https://bundlejs.com/?q=micromark409 410[bundle-size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=micromark411 412[chat]: https://github.com/micromark/micromark/discussions413 414[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg415 416[cheat]: https://commonmark.org/help/417 418[coc]: https://github.com/micromark/.github/blob/main/code-of-conduct.md419 420[commonmark]: https://commonmark.org421 422[comparison]: https://github.com/micromark/micromark#comparison423 424[contribute]: #contribute425 426[contributing]: https://github.com/micromark/.github/blob/main/contributing.md427 428[coverage]: https://codecov.io/github/micromark/micromark429 430[coverage-badge]: https://img.shields.io/codecov/c/github/micromark/micromark.svg431 432[development]: https://nodejs.org/api/packages.html#packages_resolving_user_conditions433 434[directives]: https://github.com/micromark/micromark-extension-directive435 436[downloads]: https://www.npmjs.com/package/micromark437 438[downloads-badge]: https://img.shields.io/npm/dm/micromark.svg439 440[encoding]: https://nodejs.org/api/util.html#whatwg-supported-encodings441 442[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c443 444[esmsh]: https://esm.sh445 446[extensions]: https://github.com/micromark/micromark#extensions447 448[frontmatter]: https://github.com/micromark/micromark-extension-frontmatter449 450[gfm]: https://github.com/micromark/micromark-extension-gfm451 452[health]: https://github.com/micromark/.github453 454[license]: https://github.com/micromark/micromark/blob/main/license455 456[markdown-rs]: https://github.com/wooorm/markdown-rs457 458[math]: https://github.com/micromark/micromark-extension-math459 460[mdast-util-to-markdown]: https://github.com/syntax-tree/mdast-util-to-markdown461 462[mdxjs]: https://github.com/micromark/micromark-extension-mdxjs463 464[micromark]: https://github.com/micromark/micromark465 466[npm]: https://docs.npmjs.com/cli/install467 468[opencollective]: https://opencollective.com/unified469 470[security]: #security471 472[securitymd]: https://github.com/micromark/.github/blob/main/security.md473 474[site]: https://unifiedjs.com475 476[size-debug]: https://github.com/micromark/micromark#size--debug477 478[sponsor]: #sponsor479 480[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg481 482[support]: https://github.com/micromark/.github/blob/main/support.md483 484[test]: https://github.com/micromark/micromark#test485 486[typescript]: https://www.typescriptlang.org487 488[uint8-array]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array489