Brunobkr/llama.cpp_AlgMor24_github

1# remark-html2 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 HTML.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(remarkHtml[, options])`](#unifieduseremarkhtml-options)21    *   [`Options`](#options)22*   [Types](#types)23*   [Compatibility](#compatibility)24*   [Security](#security)25*   [Related](#related)26*   [Contribute](#contribute)27*   [License](#license)28 29## What is this?30 31This package is a [unified][] ([remark][]) plugin that compiles markdown to32HTML.33 34## When should I use this?35 36This plugin is useful when you want to turn markdown into HTML.37It’s a shortcut for38`.use(remarkRehype).use(rehypeSanitize).use(rehypeStringify)`.39 40The reason that there are different ecosystems for markdown and HTML is that41turning markdown into HTML is, while frequently needed, not the only purpose of42markdown.43Checking (linting) and formatting markdown are also common use cases for44remark and markdown.45There are several aspects of markdown that do not translate 1-to-1 to HTML.46In some cases markdown contains more information than HTML: for example, there47are several ways to add a link in markdown (as in, autolinks: `<https://url>`,48resource links: `[label](url)`, and reference links with definitions:49`[label][id]` and `[id]: url`).50In other cases HTML contains more information than markdown: there are many51tags, which add new meaning (semantics), available in HTML that aren’t available52in markdown.53If there was just one AST, it would be quite hard to perform the tasks that54several remark and rehype plugins currently do.55 56This plugin is useful when you want to quickly turn markdown into HTML.57In most cases though, it’s recommended to use [`remark-rehype`][remark-rehype]58instead and finally use [`rehype-stringify`][rehype-stringify] to serialize59HTML.60The reason using both ecosystems instead of this plugin is recommended, is that61there are many useful rehype plugins that you can then use.62For example, you can [minify HTML][rehype-minify], [format HTML][rehype-format],63[highlight code][rehype-highlight], [add metadata][rehype-meta], and a lot more.64 65## Install66 67This package is [ESM only][esm].68In Node.js (version 16+), install with [npm][]:69 70```sh71npm install remark-html72```73 74In Deno with [`esm.sh`][esmsh]:75 76```js77import remarkHtml from 'https://esm.sh/remark-html@16'78```79 80In browsers with [`esm.sh`][esmsh]:81 82```html83<script type="module">84  import remarkHtml from 'https://esm.sh/remark-html@16?bundle'85</script>86```87 88## Use89 90Say we have the following file `example.md`:91 92```markdown93# Pluto94 95**Pluto** (minor-planet designation: **134340 Pluto**) is a96[dwarf planet](https://en.wikipedia.org/wiki/Dwarf_planet) in the97[Kuiper belt](https://en.wikipedia.org/wiki/Kuiper_belt).98```99 100…and a module `example.js`:101 102```js103import remarkHtml from 'remark-html'104import remarkParse from 'remark-parse'105import {read} from 'to-vfile'106import {unified} from 'unified'107 108const file = await unified()109  .use(remarkParse)110  .use(remarkHtml)111  .process(await read('example.md'))112 113console.log(String(file))114```115 116…then running `node example.js` yields:117 118```html119<h1>Pluto</h1>120<p><strong>Pluto</strong> (minor-planet designation: <strong>134340 Pluto</strong>) is a121<a href="https://en.wikipedia.org/wiki/Dwarf_planet">dwarf planet</a> in the122<a href="https://en.wikipedia.org/wiki/Kuiper_belt">Kuiper belt</a>.</p>123```124 125## API126 127This package exports no identifiers.128The default export is [`remarkHtml`][api-remark-html].129 130### `unified().use(remarkHtml[, options])`131 132Serialize markdown as HTML.133 134###### Parameters135 136*   `options` ([`Options`][api-options], optional)137    — configuration138 139###### Returns140 141Transform ([`Transformer`][unified-transformer]).142 143###### Notes144 145Passing `sanitize: false` is dangerous.146It allows arbitrary HTML and does not sanitize elements.147 148### `Options`149 150Configuration (TypeScript type).151 152###### Fields153 154*   `handlers` ([`Handlers` from155    `mdast-util-to-hast`][mdast-util-to-hast-handlers], optional)156    — how to turn mdast nodes into hast nodes157*   `sanitize` ([`Schema` from158    `hast-util-sanitize`][hast-util-sanitize-schema] or `boolean`, default:159    `true`)160    — sanitize the output, and how161*   `...toHtmlOptions` ([`Options` from162    `hast-util-to-html`][hast-util-to-html-options], optional)163    — other options are passed to `hast-util-to-html`164 165## Types166 167This package is fully typed with [TypeScript][].168It exports the additional type [`Options`][api-options].169 170## Compatibility171 172Projects maintained by the unified collective are compatible with maintained173versions of Node.js.174 175When we cut a new major release, we drop support for unmaintained versions of176Node.177This means we try to keep the current release line, `remark-html@^16`,178compatible with Node.js 16.179 180This plugin works with `unified` version 6+ and `remark` version 15+.181 182## Security183 184Use of `remark-html` is safe by default.185Passing `sanitize: false` is unsafe and opens you up to186[cross-site scripting (XSS)][wiki-xss] attacks.187A safe schema is used by default, but passing an unsafe schema is unsafe.188 189## Related190 191*   [`remark-rehype`](https://github.com/remarkjs/remark-rehype)192    — turn markdown into HTML to support rehype193*   [`rehype-sanitize`](https://github.com/rehypejs/rehype-sanitize)194    — sanitize HTML195 196## Contribute197 198See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways199to get started.200See [`support.md`][support] for ways to get help.201 202This project has a [code of conduct][coc].203By interacting with this repository, organization, or community you agree to204abide by its terms.205 206## License207 208[MIT][license] © [Titus Wormer][author]209 210<!-- Definitions -->211 212[build-badge]: https://github.com/remarkjs/remark-html/workflows/main/badge.svg213 214[build]: https://github.com/remarkjs/remark-html/actions215 216[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-html.svg217 218[coverage]: https://codecov.io/github/remarkjs/remark-html219 220[downloads-badge]: https://img.shields.io/npm/dm/remark-html.svg221 222[downloads]: https://www.npmjs.com/package/remark-html223 224[size-badge]: https://img.shields.io/bundlejs/size/remark-html225 226[size]: https://bundlejs.com/?q=remark-html227 228[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg229 230[backers-badge]: https://opencollective.com/unified/backers/badge.svg231 232[collective]: https://opencollective.com/unified233 234[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg235 236[chat]: https://github.com/remarkjs/remark/discussions237 238[npm]: https://docs.npmjs.com/cli/install239 240[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c241 242[esmsh]: https://esm.sh243 244[health]: https://github.com/remarkjs/.github245 246[contributing]: https://github.com/remarkjs/.github/blob/main/contributing.md247 248[support]: https://github.com/remarkjs/.github/blob/main/support.md249 250[coc]: https://github.com/remarkjs/.github/blob/main/code-of-conduct.md251 252[license]: license253 254[author]: https://wooorm.com255 256[hast-util-sanitize-schema]: https://github.com/syntax-tree/hast-util-sanitize#schema257 258[hast-util-to-html-options]: https://github.com/syntax-tree/hast-util-to-html#options259 260[mdast-util-to-hast-handlers]: https://github.com/syntax-tree/mdast-util-to-hast#handlers261 262[rehype-format]: https://github.com/rehypejs/rehype-format263 264[rehype-highlight]: https://github.com/rehypejs/rehype-highlight265 266[rehype-meta]: https://github.com/rehypejs/rehype-meta267 268[rehype-minify]: https://github.com/rehypejs/rehype-minify269 270[rehype-stringify]: https://github.com/rehypejs/rehype/tree/main/packages/rehype-stringify271 272[remark]: https://github.com/remarkjs/remark273 274[remark-rehype]: https://github.com/remarkjs/remark-rehype275 276[typescript]: https://www.typescriptlang.org277 278[unified]: https://github.com/unifiedjs/unified279 280[unified-transformer]: https://github.com/unifiedjs/unified#transformer281 282[wiki-xss]: https://en.wikipedia.org/wiki/Cross-site_scripting283 284[api-options]: #options285 286[api-remark-html]: #unifieduseremarkhtml-options287