Brunobkr/llama.cpp_AlgMor24_github

1# micromark-factory-label2 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][] factory to parse labels (found in media, definitions).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  * [`factoryLabel(…)`](#factorylabel)21* [Types](#types)22* [Compatibility](#compatibility)23* [Security](#security)24* [Contribute](#contribute)25* [License](#license)26 27## What is this?28 29This package exposes states to parse labels.30 31## When should I use this?32 33This package is useful when you are making your own micromark extensions.34 35## Install36 37This package is [ESM only][esm].38In Node.js (version 16+), install with [npm][]:39 40```sh41npm install micromark-factory-label42```43 44In Deno with [`esm.sh`][esmsh]:45 46```js47import {factoryLabel} from 'https://esm.sh/micromark-factory-label@1'48```49 50In browsers with [`esm.sh`][esmsh]:51 52```html53<script type="module">54  import {factoryLabel} from 'https://esm.sh/micromark-factory-label@1?bundle'55</script>56```57 58## Use59 60```js61import {ok as assert} from 'devlop'62import {factoryLabel} from 'micromark-factory-label'63import {codes, types} from 'micromark-util-symbol'64 65// A micromark tokenizer that uses the factory:66/**67 * @this {TokenizeContext}68 *   Context.69 * @type {Tokenizer}70 */71function tokenizeDefinition(effects, ok, nok) {72  return start73 74  // …75 76  /** @type {State} */77  function start(code) {78    assert(code === codes.leftSquareBracket, 'expected `[`')79    effects.enter(types.definition)80    return factoryLabel.call(81      self,82      effects,83      labelAfter,84      nok,85      types.definitionLabel,86      types.definitionLabelMarker,87      types.definitionLabelString88    )(code)89  }90 91  // …92}93```94 95## API96 97This module exports the identifier [`factoryLabel`][api-factory-label].98There is no default export.99 100### `factoryLabel(…)`101 102Parse labels.103 104> 👉 **Note**: labels in markdown are capped at 999 characters in the string.105 106###### Examples107 108```markdown109[a]110[a111b]112[a\]b]113```114 115###### Parameters116 117* `this` (`TokenizeContext`)118  — tokenize context119* `effects` (`Effects`)120  — context121* `ok` (`State`)122  — state switched to when successful123* `nok` (`State`)124  — state switched to when unsuccessful125* `type` (`string`)126  — type of the whole label (`[a]`)127* `markerType` (`string`)128  — type for the markers (`[` and `]`)129* `stringType` (`string`)130  — type for the identifier (`a`)131 132###### Returns133 134Start state (`State`).135 136## Types137 138This package is fully typed with [TypeScript][].139It exports no additional types.140 141## Compatibility142 143Projects maintained by the unified collective are compatible with maintained144versions of Node.js.145 146When we cut a new major release, we drop support for unmaintained versions of147Node.148This means we try to keep the current release line,149`micromark-factory-label@2`, compatible with Node.js 16.150This package works with `micromark@3`.151 152## Security153 154This package is safe.155See [`security.md`][securitymd] in [`micromark/.github`][health] for how to156submit a security report.157 158## Contribute159 160See [`contributing.md`][contributing] in [`micromark/.github`][health] for ways161to get started.162See [`support.md`][support] for ways to get help.163 164This project has a [code of conduct][coc].165By interacting with this repository, organisation, or community you agree to166abide by its terms.167 168## License169 170[MIT][license] © [Titus Wormer][author]171 172<!-- Definitions -->173 174[build-badge]: https://github.com/micromark/micromark/workflows/main/badge.svg175 176[build]: https://github.com/micromark/micromark/actions177 178[coverage-badge]: https://img.shields.io/codecov/c/github/micromark/micromark.svg179 180[coverage]: https://codecov.io/github/micromark/micromark181 182[downloads-badge]: https://img.shields.io/npm/dm/micromark-factory-label.svg183 184[downloads]: https://www.npmjs.com/package/micromark-factory-label185 186[bundle-size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=micromark-factory-label187 188[bundle-size]: https://bundlejs.com/?q=micromark-factory-label189 190[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg191 192[backers-badge]: https://opencollective.com/unified/backers/badge.svg193 194[opencollective]: https://opencollective.com/unified195 196[npm]: https://docs.npmjs.com/cli/install197 198[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c199 200[esmsh]: https://esm.sh201 202[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg203 204[chat]: https://github.com/micromark/micromark/discussions205 206[license]: https://github.com/micromark/micromark/blob/main/license207 208[author]: https://wooorm.com209 210[health]: https://github.com/micromark/.github211 212[securitymd]: https://github.com/micromark/.github/blob/main/security.md213 214[contributing]: https://github.com/micromark/.github/blob/main/contributing.md215 216[support]: https://github.com/micromark/.github/blob/main/support.md217 218[coc]: https://github.com/micromark/.github/blob/main/code-of-conduct.md219 220[typescript]: https://www.typescriptlang.org221 222[micromark]: https://github.com/micromark/micromark223 224[api-factory-label]: #factorylabel225