{"_id":"remark-footnotes","_rev":"607507","name":"remark-footnotes","description":"remark plugin to add support for pandoc footnotes","dist-tags":{"latest":"4.0.1"},"maintainers":[{"name":"johno","email":"johnotander@gmail.com"},{"name":"wooorm","email":"tituswormer@gmail.com"}],"time":{"modified":"2021-08-22T07:05:47.000Z","created":"2020-03-29T14:06:50.990Z","4.0.1":"2021-08-22T07:04:30.489Z","4.0.0":"2021-08-05T11:06:28.499Z","3.0.0":"2020-10-04T08:25:34.429Z","2.0.0":"2020-08-22T14:00:23.192Z","1.0.0":"2020-03-29T14:06:50.990Z"},"users":{},"author":{"name":"Titus Wormer","email":"tituswormer@gmail.com","url":"https://wooorm.com"},"repository":{"type":"git","url":"git+https://github.com/remarkjs/remark-footnotes.git"},"versions":{"4.0.1":{"name":"remark-footnotes","version":"4.0.1","description":"remark plugin to add support for pandoc footnotes","license":"MIT","keywords":["unified","remark","remark-plugin","plugin","mdast","markdown","footnote","note","definition","pandoc"],"repository":{"type":"git","url":"git+https://github.com/remarkjs/remark-footnotes.git"},"bugs":{"url":"https://github.com/remarkjs/remark-footnotes/issues"},"funding":{"type":"opencollective","url":"https://opencollective.com/unified"},"author":{"name":"Titus Wormer","email":"tituswormer@gmail.com","url":"https://wooorm.com"},"contributors":[{"name":"Titus Wormer","email":"tituswormer@gmail.com","url":"https://wooorm.com"}],"sideEffects":false,"type":"module","main":"index.js","types":"index.d.ts","dependencies":{"@types/mdast":"^3.0.0","mdast-util-footnote":"^1.0.0","micromark-extension-footnote":"^1.0.0","unified":"^10.0.0"},"devDependencies":{"@types/tape":"^4.0.0","c8":"^7.0.0","prettier":"^2.0.0","rehype-format":"^4.0.0","rehype-stringify":"^9.0.0","remark-cli":"^10.0.0","remark-parse":"^10.0.0","remark-preset-wooorm":"^9.0.0","remark-rehype":"^9.0.0","remark-stringify":"^10.0.0","rimraf":"^3.0.0","tape":"^5.0.0","to-vfile":"^7.0.0","type-coverage":"^2.0.0","typescript":"^4.0.0","unist-builder":"^3.0.0","unist-util-remove-position":"^4.0.0","xo":"^0.44.0"},"scripts":{"build":"rimraf \"test/**/*.d.ts\" \"*.d.ts\" && tsc && type-coverage","format":"remark . -qfo && prettier . -w --loglevel warn && xo --fix","test-api":"node --conditions development test/index.js","test-coverage":"c8 --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 --reporter lcov npm run test-api","test":"npm run build && npm run format && npm run test-coverage"},"prettier":{"tabWidth":2,"useTabs":false,"singleQuote":true,"bracketSpacing":false,"semi":false,"trailingComma":"none"},"xo":{"prettier":true},"remarkConfig":{"plugins":["preset-wooorm"]},"typeCoverage":{"atLeast":100,"detail":true,"strict":true,"ignoreCatch":true},"gitHead":"cab264be693b4cb4d8f924a39df48341d81a8e86","homepage":"https://github.com/remarkjs/remark-footnotes#readme","_id":"remark-footnotes@4.0.1","_nodeVersion":"16.6.1","_npmVersion":"7.20.6","dist":{"shasum":"17d3c87ddc240924e8b4590b34a3d79aa8ede50c","size":4458,"noattachment":false,"key":"/remark-footnotes/-/remark-footnotes-4.0.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/remark-footnotes/download/remark-footnotes-4.0.1.tgz"},"_npmUser":{"name":"wooorm","email":"tituswormer@gmail.com"},"directories":{},"maintainers":[{"name":"johno","email":"johnotander@gmail.com"},{"name":"wooorm","email":"tituswormer@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/remark-footnotes_4.0.1_1629615870368_0.33028281964452044"},"_hasShrinkwrap":false,"publish_time":1629615870489,"_cnpm_publish_time":1629615870489},"4.0.0":{"name":"remark-footnotes","version":"4.0.0","description":"remark plugin to add support for pandoc footnotes","license":"MIT","keywords":["unified","remark","remark-plugin","plugin","mdast","markdown","footnote","note","definition","pandoc"],"repository":{"type":"git","url":"git+https://github.com/remarkjs/remark-footnotes.git"},"bugs":{"url":"https://github.com/remarkjs/remark-footnotes/issues"},"funding":{"type":"opencollective","url":"https://opencollective.com/unified"},"author":{"name":"Titus Wormer","email":"tituswormer@gmail.com","url":"https://wooorm.com"},"contributors":[{"name":"Titus Wormer","email":"tituswormer@gmail.com","url":"https://wooorm.com"}],"sideEffects":false,"type":"module","main":"index.js","types":"index.d.ts","dependencies":{"@types/mdast":"^3.0.0","mdast-util-footnote":"^1.0.0","micromark-extension-footnote":"^1.0.0","unified":"^10.0.0"},"devDependencies":{"@types/tape":"^4.0.0","c8":"^7.0.0","dtslint":"^4.0.0","prettier":"^2.0.0","rehype-format":"^4.0.0","rehype-stringify":"^9.0.0","remark-cli":"^10.0.0","remark-parse":"^10.0.0","remark-preset-wooorm":"^8.0.0","remark-rehype":"^8.0.0","remark-stringify":"^10.0.0","rimraf":"^3.0.0","tape":"^5.0.0","to-vfile":"^7.0.0","type-coverage":"^2.0.0","typescript":"^4.0.0","unist-builder":"^3.0.0","unist-util-remove-position":"^4.0.0","xo":"^0.43.0"},"scripts":{"build":"rimraf \"test/**/*.d.ts\" \"*.d.ts\" && tsc && type-coverage","format":"remark . -qfo && prettier . -w --loglevel warn && xo --fix","test-api":"node --conditions development test/index.js","test-coverage":"c8 --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 --reporter lcov npm run test-api","test":"npm run build && npm run format && npm run test-coverage"},"prettier":{"tabWidth":2,"useTabs":false,"singleQuote":true,"bracketSpacing":false,"semi":false,"trailingComma":"none"},"xo":{"prettier":true},"remarkConfig":{"plugins":["preset-wooorm"]},"typeCoverage":{"atLeast":100,"detail":true,"strict":true,"ignoreCatch":true},"gitHead":"bc2768f1a994ab398c4b6c5d49544f829a0d0cfa","homepage":"https://github.com/remarkjs/remark-footnotes#readme","_id":"remark-footnotes@4.0.0","_nodeVersion":"16.6.1","_npmVersion":"7.20.3","dist":{"shasum":"16deec1b6215fa97ec3550c20a7652431001baa9","size":4435,"noattachment":false,"key":"/remark-footnotes/-/remark-footnotes-4.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/remark-footnotes/download/remark-footnotes-4.0.0.tgz"},"_npmUser":{"name":"wooorm","email":"tituswormer@gmail.com"},"directories":{},"maintainers":[{"name":"johno","email":"johnotander@gmail.com"},{"name":"wooorm","email":"tituswormer@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/remark-footnotes_4.0.0_1628161588389_0.09729765997604956"},"_hasShrinkwrap":false,"publish_time":1628161588499,"_cnpm_publish_time":1628161588499},"3.0.0":{"name":"remark-footnotes","version":"3.0.0","description":"remark plugin to add support for pandoc footnotes","license":"MIT","keywords":["unified","remark","remark-plugin","plugin","mdast","markdown","footnote","note","definition","pandoc"],"repository":{"type":"git","url":"git+https://github.com/remarkjs/remark-footnotes.git"},"bugs":{"url":"https://github.com/remarkjs/remark-footnotes/issues"},"funding":{"type":"opencollective","url":"https://opencollective.com/unified"},"author":{"name":"Titus Wormer","email":"tituswormer@gmail.com","url":"https://wooorm.com"},"contributors":[{"name":"Titus Wormer","email":"tituswormer@gmail.com","url":"https://wooorm.com"}],"types":"types/index.d.ts","dependencies":{"mdast-util-footnote":"^0.1.0","micromark-extension-footnote":"^0.3.0"},"devDependencies":{"dtslint":"^4.0.0","nyc":"^15.0.0","prettier":"^2.0.0","rehype-format":"^3.0.0","rehype-stringify":"^8.0.0","remark-cli":"^8.0.0","remark-parse":"^9.0.0-alpha.1","remark-preset-wooorm":"^7.0.0","remark-rehype":"^8.0.0","remark-stringify":"^9.0.0-alpha.1","tape":"^5.0.0","to-vfile":"^6.0.0","unified":"^9.0.0","unist-builder":"^2.0.0","unist-util-remove-position":"^3.0.0","xo":"^0.33.0"},"scripts":{"format":"remark . -qfo && prettier . --write && xo --fix","test-api":"node test","test-coverage":"nyc --reporter lcov tape test/index.js","test-types":"dtslint types","test":"npm run format && npm run test-coverage && npm run test-types"},"nyc":{"check-coverage":true,"lines":100,"functions":100,"branches":100},"prettier":{"tabWidth":2,"useTabs":false,"singleQuote":true,"bracketSpacing":false,"semi":false,"trailingComma":"none"},"xo":{"prettier":true,"esnext":false,"rules":{"unicorn/prefer-optional-catch-binding":"off","complexity":"off","no-self-compare":"off","no-lonely-if":"off"}},"remarkConfig":{"plugins":["preset-wooorm"]},"gitHead":"828756db055ac614a3f55f94aebe0abfdf0e0eb1","homepage":"https://github.com/remarkjs/remark-footnotes#readme","_id":"remark-footnotes@3.0.0","_nodeVersion":"14.8.0","_npmVersion":"6.14.8","dist":{"shasum":"5756b56f8464fa7ed80dbba0c966136305d8cb8d","size":4352,"noattachment":false,"key":"/remark-footnotes/-/remark-footnotes-3.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/remark-footnotes/download/remark-footnotes-3.0.0.tgz"},"maintainers":[{"name":"johno","email":"johnotander@gmail.com"},{"name":"wooorm","email":"tituswormer@gmail.com"}],"_npmUser":{"name":"wooorm","email":"tituswormer@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/remark-footnotes_3.0.0_1601799934316_0.6974717508412747"},"_hasShrinkwrap":false,"publish_time":1601799934429,"_cnpm_publish_time":1601799934429},"2.0.0":{"name":"remark-footnotes","version":"2.0.0","description":"remark plugin to add support for pandoc footnotes","license":"MIT","keywords":["unified","remark","remark-plugin","plugin","mdast","markdown","footnote","note","definition","pandoc"],"repository":{"type":"git","url":"git+https://github.com/remarkjs/remark-footnotes.git"},"bugs":{"url":"https://github.com/remarkjs/remark-footnotes/issues"},"funding":{"type":"opencollective","url":"https://opencollective.com/unified"},"author":{"name":"Titus Wormer","email":"tituswormer@gmail.com","url":"https://wooorm.com"},"contributors":[{"name":"Titus Wormer","email":"tituswormer@gmail.com","url":"https://wooorm.com"}],"types":"types/index.d.ts","dependencies":{},"devDependencies":{"dtslint":"^3.0.0","nyc":"^15.0.0","prettier":"^2.0.0","rehype-format":"^3.0.0","rehype-stringify":"^8.0.0","remark-cli":"^8.0.0","remark-parse":"^8.0.0","remark-preset-wooorm":"^7.0.0","remark-rehype":"^7.0.0","remark-stringify":"^8.0.0","tape":"^5.0.0","to-vfile":"^6.0.0","unified":"^9.0.0","unist-builder":"^2.0.0","xo":"^0.33.0"},"scripts":{"format":"remark . -qfo && prettier . --write && xo --fix","test-api":"node test","test-coverage":"nyc --reporter lcov tape test/index.js","test-types":"dtslint types","test":"npm run format && npm run test-coverage && npm run test-types"},"nyc":{"check-coverage":true,"lines":100,"functions":100,"branches":100},"prettier":{"tabWidth":2,"useTabs":false,"singleQuote":true,"bracketSpacing":false,"semi":false,"trailingComma":"none"},"xo":{"prettier":true,"esnext":false,"rules":{"unicorn/prefer-optional-catch-binding":"off","complexity":"off","no-self-compare":"off","no-lonely-if":"off"}},"remarkConfig":{"plugins":["preset-wooorm"]},"gitHead":"df140ebd9f0dbe1003bfa283c87e81ee0f947f6d","homepage":"https://github.com/remarkjs/remark-footnotes#readme","_id":"remark-footnotes@2.0.0","_nodeVersion":"14.7.0","_npmVersion":"6.14.8","dist":{"shasum":"9001c4c2ffebba55695d2dd80ffb8b82f7e6303f","size":6598,"noattachment":false,"key":"/remark-footnotes/-/remark-footnotes-2.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/remark-footnotes/download/remark-footnotes-2.0.0.tgz"},"maintainers":[{"name":"johno","email":"johnotander@gmail.com"},{"name":"wooorm","email":"tituswormer@gmail.com"}],"_npmUser":{"name":"wooorm","email":"tituswormer@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/remark-footnotes_2.0.0_1598104823062_0.8560375226968222"},"_hasShrinkwrap":false,"publish_time":1598104823192,"_cnpm_publish_time":1598104823192},"1.0.0":{"name":"remark-footnotes","version":"1.0.0","description":"remark plugin to add support for pandoc footnotes","license":"MIT","keywords":["unified","remark","remark-plugin","plugin","mdast","markdown","footnote","note","definition","pandoc"],"repository":{"type":"git","url":"git+https://github.com/remarkjs/remark-footnotes.git"},"bugs":{"url":"https://github.com/remarkjs/remark-footnotes/issues"},"funding":{"type":"opencollective","url":"https://opencollective.com/unified"},"author":{"name":"Titus Wormer","email":"tituswormer@gmail.com","url":"https://wooorm.com"},"contributors":[{"name":"Titus Wormer","email":"tituswormer@gmail.com","url":"https://wooorm.com"}],"dependencies":{},"devDependencies":{"nyc":"^15.0.0","prettier":"^2.0.0","rehype-format":"^3.0.1","rehype-stringify":"^6.0.0","remark-cli":"^7.0.0","remark-parse":"^7.0.0","remark-preset-wooorm":"^6.0.0","remark-rehype":"^6.0.0","remark-stringify":"^7.0.0","tape":"^4.0.0","to-vfile":"^6.0.0","unified":"^8.0.0","unist-builder":"^2.0.0","xo":"^0.28.0"},"scripts":{"format":"remark . -qfo && prettier --write \"**/*.js\" && xo --fix","test-api":"node test","test-coverage":"nyc --reporter lcov tape test/index.js","test":"npm run format && npm run test-coverage"},"nyc":{"check-coverage":true,"lines":100,"functions":100,"branches":100},"prettier":{"tabWidth":2,"useTabs":false,"singleQuote":true,"bracketSpacing":false,"semi":false,"trailingComma":"none"},"xo":{"prettier":true,"esnext":false,"rules":{"complexity":"off","no-self-compare":"off","no-lonely-if":"off"}},"remarkConfig":{"plugins":["preset-wooorm"]},"gitHead":"5eb2291045ecf970fea14eb4313d21978b29c7bb","homepage":"https://github.com/remarkjs/remark-footnotes#readme","_id":"remark-footnotes@1.0.0","_nodeVersion":"13.10.1","_npmVersion":"6.14.3","dist":{"shasum":"9c7a97f9a89397858a50033373020b1ea2aad011","size":6386,"noattachment":false,"key":"/remark-footnotes/-/remark-footnotes-1.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/remark-footnotes/download/remark-footnotes-1.0.0.tgz"},"maintainers":[{"name":"johno","email":"johnotander@gmail.com"},{"name":"wooorm","email":"tituswormer@gmail.com"}],"_npmUser":{"name":"wooorm","email":"tituswormer@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/remark-footnotes_1.0.0_1585490810839_0.30583860983323774"},"_hasShrinkwrap":false,"publish_time":1585490810990,"_cnpm_publish_time":1585490810990}},"readme":"# remark-footnotes\n\n[![Build][build-badge]][build]\n[![Coverage][coverage-badge]][coverage]\n[![Downloads][downloads-badge]][downloads]\n[![Size][size-badge]][size]\n[![Sponsors][sponsors-badge]][collective]\n[![Backers][backers-badge]][collective]\n[![Chat][chat-badge]][chat]\n\n[**remark**][remark] plugin to add support for footnotes.\n\n## Important!\n\nThis plugin is affected by the new parser in remark\n([`micromark`](https://github.com/micromark/micromark),\nsee [`remarkjs/remark#536`](https://github.com/remarkjs/remark/pull/536)).\nUse version 2 while you’re still on remark 12.\nUse version 3 for remark 13+.\n\n## Install\n\nThis package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c):\nNode 12+ is needed to use it and it must be `import`ed instead of `require`d.\n\n[npm][]:\n\n```sh\nnpm install remark-footnotes\n```\n\n## Use\n\nSay we have the following file, `example.md`:\n\n```markdown\nHere is a footnote reference,[^1]\nanother,[^longnote],\nand optionally there are inline\nnotes.^[you can type them inline, which may be easier, since you don’t\nhave to pick an identifier and move down to type the note.]\n\n[^1]: Here is the footnote.\n\n[^longnote]: Here’s one with multiple blocks.\n\n Subsequent paragraphs are indented to show that they\nbelong to the previous footnote.\n\n { some.code }\n\n The whole paragraph can be indented, or just the first\n line. In this way, multi-paragraph footnotes work like\n multi-paragraph list items.\n\nThis paragraph won’t be part of the note, because it\nisn’t indented.\n```\n\nAnd our module, `example.js`, looks as follows:\n\n```js\nimport {readSync} from 'to-vfile'\nimport {unified} from 'unified'\nimport remarkParse from 'remark-parse'\nimport remarkFootnotes from 'remark-footnotes'\nimport remarkRehype from 'remark-rehype'\nimport rehypeFormat from 'rehype-format'\nimport rehypeStringify from 'rehype-stringify'\n\nconst file = readSync('example.md')\n\nunified()\n .use(remarkParse)\n .use(remarkFootnotes, {inlineNotes: true})\n .use(remarkRehype)\n .use(rehypeFormat)\n .use(rehypeStringify)\n .process(file)\n .then((file) => {\n console.log(String(file))\n })\n```\n\nNow, running `node example` yields:\n\n```html\n

\n Here is a footnote reference,1\n another,2,\n and optionally there are inline\n notes.3\n

\n

\n This paragraph won’t be part of the note, because it\n isn’t indented.\n

\n
\n
\n
    \n
  1. \n

    Here is the footnote.↩

    \n
    2. \n
  2. \n

    Here’s one with multiple blocks.

    \n

    \n Subsequent paragraphs are indented to show that they\n belong to the previous footnote.\n

    \n 
    { some.code }\n
    \n

    \n The whole paragraph can be indented, or just the first\n line. In this way, multi-paragraph footnotes work like\n multi-paragraph list items.↩\n

    \n
    3. \n
  3. \n

    \n you can type them inline, which may be easier, since you don’t\n have to pick an identifier and move down to type the note.↩\n

    \n
    4. \n
\n
\n```\n\n## API\n\nThis package exports no identifiers.\nThe default export is `remarkFootnotes`.\n\n### `unified().use(remarkFootnotes[, options])`\n\nPlugin to add support for footnotes.\n\n###### `options.inlineNotes`\n\nWhether to support `^[inline notes]` (`boolean`, default: `false`).\nPassed to [`micromark-extension-footnote`][mm-footnote].\n\n###### Notes\n\n* Labels, such as `[^this]` (in a footnote reference) or `[^this]:` (in a\n footnote definition) work like link references\n* Footnote definitions work like lists\n* Image and link references cannot start with carets, so `![^this doesn’t\n work][]`\n\n## Security\n\nUse of `remark-footnotes` does not involve [**rehype**][rehype]\n([**hast**][hast]) or user content so there are no openings for [cross-site\nscripting (XSS)][xss] attacks.\n\n## Related\n\n* [`remark-gfm`](https://github.com/remarkjs/remark-gfm)\n — GitHub Flavored Markdown\n* [`remark-frontmatter`](https://github.com/remarkjs/remark-frontmatter)\n — Frontmatter (YAML, TOML, and more)\n* [`remark-math`](https://github.com/remarkjs/remark-math)\n — Math\n* [`remark-github`](https://github.com/remarkjs/remark-github)\n — Auto-link references like in GitHub issues, PRs, and comments\n\n## Contribute\n\nSee [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways\nto get started.\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] © [Titus Wormer][author]\n\n\n\n[build-badge]: https://github.com/remarkjs/remark-footnotes/workflows/main/badge.svg\n\n[build]: https://github.com/remarkjs/remark-footnotes/actions\n\n[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-footnotes.svg\n\n[coverage]: https://codecov.io/github/remarkjs/remark-footnotes\n\n[downloads-badge]: https://img.shields.io/npm/dm/remark-footnotes.svg\n\n[downloads]: https://www.npmjs.com/package/remark-footnotes\n\n[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-footnotes.svg\n\n[size]: https://bundlephobia.com/result?p=remark-footnotes\n\n[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg\n\n[backers-badge]: https://opencollective.com/unified/backers/badge.svg\n\n[collective]: https://opencollective.com/unified\n\n[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg\n\n[chat]: https://github.com/remarkjs/remark/discussions\n\n[npm]: https://docs.npmjs.com/cli/install\n\n[health]: https://github.com/remarkjs/.github\n\n[contributing]: https://github.com/remarkjs/.github/blob/HEAD/contributing.md\n\n[support]: https://github.com/remarkjs/.github/blob/HEAD/support.md\n\n[coc]: https://github.com/remarkjs/.github/blob/HEAD/code-of-conduct.md\n\n[license]: license\n\n[author]: https://wooorm.com\n\n[remark]: https://github.com/remarkjs/remark\n\n[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting\n\n[rehype]: https://github.com/rehypejs/rehype\n\n[hast]: https://github.com/syntax-tree/hast\n\n[mm-footnote]: https://github.com/micromark/micromark-extension-footnote#optionsinlinenotes\n","_attachments":{},"homepage":"https://github.com/remarkjs/remark-footnotes#readme","bugs":{"url":"https://github.com/remarkjs/remark-footnotes/issues"},"license":"MIT"}