Brunobkr/llama.cpp_AlgMor24_github

1# micromark-util-decode-string2 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 11[micromark][] utility to decode markdown strings.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  * [`decodeString(value)`](#decodestringvalue)21* [Types](#types)22* [Compatibility](#compatibility)23* [Security](#security)24* [Contribute](#contribute)25* [License](#license)26 27## What is this?28 29This package exposes an algorithm to parse character escapes and character30references.31 32## When should I use this?33 34This package might be useful when you are making your own micromark extensions.35 36## Install37 38This package is [ESM only][esm].39In Node.js (version 16+), install with [npm][]:40 41```sh42npm install micromark-util-decode-string43```44 45In Deno with [`esm.sh`][esmsh]:46 47```js48import {decodeString} from 'https://esm.sh/micromark-util-decode-string@1'49```50 51In browsers with [`esm.sh`][esmsh]:52 53```html54<script type="module">55  import {decodeString} from 'https://esm.sh/micromark-util-decode-string@1?bundle'56</script>57```58 59## Use60 61```js62import {decodeString} from 'micromark-util-decode-string'63 64decodeString('a &semi; b') // 'a ; b'65decodeString('a \\; b') // 'a ; b'66decodeString('a ; b') // 'a ; b'67```68 69## API70 71This module exports the identifier [`decodeString`][api-decode-string].72There is no default export.73 74### `decodeString(value)`75 76Decode markdown strings (which occur in places such as fenced code info strings,77destinations, labels, and titles).78 79The “string” content type allows character escapes and -references.80This decodes those.81 82###### Parameters83 84* `value` (`string`)85  — value to decode86 87###### Returns88 89Decoded value (`string`).90 91## Types92 93This package is fully typed with [TypeScript][].94It exports no additional types.95 96## Compatibility97 98Projects maintained by the unified collective are compatible with maintained99versions of Node.js.100 101When we cut a new major release, we drop support for unmaintained versions of102Node.103This means we try to keep the current release line,104`micromark-util-decode-string@2`, compatible with Node.js 16.105This package works with `micromark@3`.106 107## Security108 109This package is safe.110See [`security.md`][securitymd] in [`micromark/.github`][health] for how to111submit a security report.112 113## Contribute114 115See [`contributing.md`][contributing] in [`micromark/.github`][health] for ways116to get started.117See [`support.md`][support] for ways to get help.118 119This project has a [code of conduct][coc].120By interacting with this repository, organisation, or community you agree to121abide by its terms.122 123## License124 125[MIT][license] © [Titus Wormer][author]126 127<!-- Definitions -->128 129[build-badge]: https://github.com/micromark/micromark/workflows/main/badge.svg130 131[build]: https://github.com/micromark/micromark/actions132 133[coverage-badge]: https://img.shields.io/codecov/c/github/micromark/micromark.svg134 135[coverage]: https://codecov.io/github/micromark/micromark136 137[downloads-badge]: https://img.shields.io/npm/dm/micromark-util-normalize-identifier.svg138 139[downloads]: https://www.npmjs.com/package/micromark-util-normalize-identifier140 141[bundle-size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=micromark-util-normalize-identifier142 143[bundle-size]: https://bundlejs.com/?q=micromark-util-normalize-identifier144 145[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg146 147[backers-badge]: https://opencollective.com/unified/backers/badge.svg148 149[opencollective]: https://opencollective.com/unified150 151[npm]: https://docs.npmjs.com/cli/install152 153[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c154 155[esmsh]: https://esm.sh156 157[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg158 159[chat]: https://github.com/micromark/micromark/discussions160 161[license]: https://github.com/micromark/micromark/blob/main/license162 163[author]: https://wooorm.com164 165[health]: https://github.com/micromark/.github166 167[securitymd]: https://github.com/micromark/.github/blob/main/security.md168 169[contributing]: https://github.com/micromark/.github/blob/main/contributing.md170 171[support]: https://github.com/micromark/.github/blob/main/support.md172 173[coc]: https://github.com/micromark/.github/blob/main/code-of-conduct.md174 175[typescript]: https://www.typescriptlang.org176 177[micromark]: https://github.com/micromark/micromark178 179[api-decode-string]: #decodestringvalue180