@wadler1989. @{hughes1990.}
\n```\n\n## API\n\nThis package exports the following identifiers: `citekey`, `citekeyHtml`.\nThere is no default export.\n\nThe export map supports the endorsed [`development`\ncondition](https://nodejs.org/api/packages.html#packages_resolving_user_conditions).\nRun `node --conditions development module.js` to get instrumented dev code.\nWithout this condition, production code is loaded.\n\n### `citekey(options?)`\n\nFunction that can be called with options to get an extension for micromark to\nparse [Pandoc][]-style citation keys (can be passed in `extensions`).\n\n###### `options.strict`\n\nA `boolean` option to restrict citation keys to ASCII.\n\nIf set to `true`, citation keys end at the first non-ASCII character.\nFor example, running the script:\n\n```js\nimport {micromark} from 'micromark'\nimport {citekey, citekeyHtml} from '@bernardjoseph/micromark-extension-citekey'\n\nconst out = micromark('@müller', {\n extensions: [citekey({strict: true})],\n htmlExtensions: [citekeyHtml]\n})\n\nconsole.log(out)\n```\n\nYields:\n\n```html\n@müller
\n```\n\nThe default value is `false`.\n\n### `citekeyHtml`\n\nExtension for micromark to compile [Pandoc][]-style citation keys to HTML (can\nbe passed in `htmlExtensions`).\n\n###### Caveats\n\nLabeled item markers of [Pandoc numbered example\nlists][pandoc-numbered-example-lists] look like [Pandoc][]-style citation keys:\n\n```markdown\n(@good) This is a good example.\n\nAs (@good) illustrates, ...\n```\n\nCurrently, there exists no **[micromark][]** extension for [Pandoc numbered\nexample lists][pandoc-numbered-example-lists].\nWithout such an extension, all labeled item markers are parsed as citation keys.\n\n## Syntax\n\nThe syntax of [Pandoc][]-style citation keys is described in the [Pandoc\nmanual][pandoc-citation-syntax].\n\nThe [Pandoc manual][pandoc-manual] does not specify what characters are allowed\nto precede a citation key.\nThis extension imitates the behavior of the [Pandoc][] parser and allows all\ncharacters except alphanumerics and periods to precede a citation key.\n\n## Related\n\n* [`remarkjs/remark`][remark]\n — markdown processor powered by plugins\n* [`remark-citekey`][remark-citekey]\n — remark plugin to support citation keys\n* [`micromark/micromark`][micromark]\n — the smallest commonmark-compliant markdown parser that exists\n* [`mdast-util-citekey`][mdast-util-citekey]\n — mdast utility to support citation keys\n* [`syntax-tree/mdast-util-from-markdown`][from-markdown]\n — mdast parser using `micromark` to create mdast from markdown\n* [`syntax-tree/mdast-util-to-markdown`][to-markdown]\n — mdast serializer to create markdown from mdast\n\n## Contribute\n\nSee [`contributing.md` in `micromark/.github`][contributing] for ways to get\nstarted.\nSee [`support.md`][support] for ways to get help.\n\nThis project has a [code of conduct][coc].\nBy interacting with this repository, organization, or community you agree to\nabide by its terms.\n\n## License\n\n[MIT][license] © Bernd Rellermeyer\n\n\n\n[npm]: https://docs.npmjs.com/cli/install\n\n[remark]: https://github.com/remarkjs/remark\n\n[remark-citekey]: https://github.com/bernardjoseph/remark-citekey\n\n[from-markdown]: https://github.com/syntax-tree/mdast-util-from-markdown\n\n[to-markdown]: https://github.com/syntax-tree/mdast-util-to-markdown\n\n[mdast-util-citekey]: https://github.com/bernardjoseph/mdast-util-citekey\n\n[micromark]: https://github.com/micromark/micromark\n\n[pandoc]: https://pandoc.org\n\n[pandoc-manual]: https://pandoc.org/MANUAL.html\n\n[pandoc-citation-syntax]: https://pandoc.org/MANUAL.html#citation-syntax\n\n[pandoc-numbered-example-lists]: https://pandoc.org/MANUAL.html#numbered-example-lists\n\n[contributing]: https://github.com/unifiedjs/.github/blob/HEAD/contributing.md\n\n[support]: https://github.com/unifiedjs/.github/blob/HEAD/support.md\n\n[coc]: https://github.com/unifiedjs/.github/blob/HEAD/code-of-conduct.md\n\n[license]: https://github.com/micromark/micromark/blob/main/license\n","readmeFilename":"readme.md"}