{ "name": "remark-footnotes", "versions": { "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": { "integrity": "sha512-X9Ncj4cj3/CIvLI2Z9IobHtVi8FVdUrdJkCNaL9kdX8ohfsi18DXHsCVd/A7ssARBdccdDb5ODnt62WuEWaM/g==", "shasum": "9c7a97f9a89397858a50033373020b1ea2aad011", "tarball": "https://registry.npmjs.org/remark-footnotes/-/remark-footnotes-1.0.0.tgz", "fileCount": 4, "unpackedSize": 20682, "npm-signature": "-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJegKt7CRA9TVsSAnZWagAAvDUQAKDQQ0V9HpGPLV7n89hJ\nxV5atJgSGhGebDioqnxuNrgRmKbbQ+Kh82X49YZCJlqrWWLKnG+lV9UrK3Hp\nBpjhQn22LdHtdiwpN+mKuatWkO1ZMOcM+pkDm2Ex+8FA0yBcGSod3OyjKDNw\nnkAp9lp2ef7evIUuk7eQvMaNU0g3x6JbDyEAHL4K+M0cSfqGCCxk8jEP7Fkg\nocHtlwoaZn3G1XQMLXMYNrBrmICVqhduvgEs+lbOaEOS6XJsvJpCT8DnSgG9\nbudLoNVJU1HFxnWLwBjI9FysVRuhyfi5WowMli1XdN7X1Cv3xYliZGz+adQw\nl+UnlikvhV2ljagFo1ej+lrOBFHyf2o2+tMNRT9jjUnWlJ+2nOSC6GLo+HaS\nPlGKYQNBNghSXf/keASzDOURpuFhEltH8w8VcUw9kIbxloEEJzoh6WK1o1eQ\nz1kqbRcJYHOlgTksduUQ8h6cdiPsanI8siD7ikqvu5d6Ng9q5vbF60ziPpcG\nGnbTHLvdGnQy1nn92pLezb/fRki16OiNEA7A4HDnlYD/Bd3Lxj7vin9hy9+k\nKtsukyK8fgKJ5Xf68fPq3ZWZvBVl1VOzMyt5sjVQg/6k4jpySYEfBeQazmx+\nW2biiQV6weVf3DmOywDr0Q380FfndJj4LyXUj9LL2pJf4N9O9JGQBFvVOwuW\ni/zb\r\n=ly8I\r\n-----END PGP SIGNATURE-----\r\n" }, "maintainers": [ { "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 }, "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": { "integrity": "sha512-3Clt8ZMH75Ayjp9q4CorNeyjwIxHFcTkaektplKGl2A1jNGEUey8cKL0ZC5vJwfcD5GFGsNLImLG/NGzWIzoMQ==", "shasum": "9001c4c2ffebba55695d2dd80ffb8b82f7e6303f", "tarball": "https://registry.npmjs.org/remark-footnotes/-/remark-footnotes-2.0.0.tgz", "fileCount": 5, "unpackedSize": 21227, "npm-signature": "-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfQST3CRA9TVsSAnZWagAAzBwP/0cZFuBKhjSduOxB0GBc\nyEA5GjEokzUgXSm6wI/UDk8UepL9zQLTBNLOFXV8k0GkXBZUDurrwDcii6ff\nPdxbTf0DIuBKGhFP5I+VTS99UaOx16LbDFJZa4ozZtpVfGOByVYTK0Db17dk\njAfrYSgvXnrSSt49vxTs+LzxKcfCPA+hXFJpSKV4+a0mZF+haFksxqd3Qwb8\n7xi9GxfoQjfW838AaOyipwaAPHQW+4B57Hk9w/EY57/ypRSZ9oIdWf9k9QJo\nmhQsJ8HLJ/ZN2cN0qhcNpg1UC4ZHYWpWAjRa4cMn+t7A7ByyVuO8DbeYBZJz\nVgl6vaeOpEqzsYgPGWkuuQIpVKE4KtgdqG4ryVAszdmGTNGDud2lrczBBbst\niq0AYmuwaSST1attxxG3xZleiAzXztiG70g1MQeBmm3HIzz1I6M0jbEOOMim\njCKMJgNTWWAk+B45R5xOfgUj7og2yAU6yhLhMQpnfa4ymUiPCjA1mDFWrFwp\nCHeAOrOULjx0KqnbB5IiCUO+ZeFrF5WWzQarjr6+R3OMLhn78m3niMBI+tgl\nN8IR0yz1AZxi3lRaI5zrBx3wX0wchE6X75UdQ+MbBj3UJ2f/GveGhMpQbTSI\n+2xpYow+DVnmZojq8+PSI0WyfYhMOLd5p+HYjLSD3klvJFE9lZOulKsSZkIW\n+kqG\r\n=Eg+c\r\n-----END PGP SIGNATURE-----\r\n" }, "maintainers": [ { "email": "johnotander@gmail.com", "name": "johno" }, { "email": "tituswormer@gmail.com", "name": "wooorm" } ], "_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 } }, "time": { "created": "2020-03-29T14:06:50.839Z", "1.0.0": "2020-03-29T14:06:50.990Z", "modified": "2020-08-22T14:00:25.397Z", "2.0.0": "2020-08-22T14:00:23.192Z" }, "users": {}, "dist-tags": { "latest": "2.0.0" }, "_uplinks": { "npmjs": { "etag": "W/\"62b2d27e3aa43fad64d2fc3d1f0dc729\"", "fetched": 1600679311670 } }, "_distfiles": { "remark-footnotes-1.0.0.tgz": { "url": "https://registry.npmjs.org/remark-footnotes/-/remark-footnotes-1.0.0.tgz", "sha": "9c7a97f9a89397858a50033373020b1ea2aad011", "registry": "npmjs" }, "remark-footnotes-2.0.0.tgz": { "url": "https://registry.npmjs.org/remark-footnotes/-/remark-footnotes-2.0.0.tgz", "sha": "9001c4c2ffebba55695d2dd80ffb8b82f7e6303f", "registry": "npmjs" } }, "_attachments": { "remark-footnotes-2.0.0.tgz": { "shasum": "9001c4c2ffebba55695d2dd80ffb8b82f7e6303f" } }, "_rev": "2-ae80ce78ddd4a91c", "_id": "remark-footnotes", "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## Install\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 script, `example.js`, looks as follows:\n\n```js\nvar vfile = require('to-vfile')\nvar unified = require('unified')\nvar markdown = require('remark-parse')\nvar remark2rehype = require('remark-rehype')\nvar format = require('rehype-format')\nvar html = require('rehype-stringify')\nvar footnotes = require('remark-footnotes')\n\nunified()\n .use(markdown)\n .use(footnotes, {inlineNotes: true})\n .use(remark2rehype)\n .use(format)\n .use(html)\n .process(vfile.readSync('example.md'), function (err, file) {\n if (err) throw err\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,longnote,\n and optionally there are inline\n notes.2\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\n### `remark().use(footnotes[, options])`\n\nPlugin to add support for footnotes.\n\n###### `options.inlineNotes`\n\nWhether to support `^[inline notes]` (`boolean`, default: `false`).\n\n###### Notes\n\n* Labels, such as `[^this]` (in a footnote reference) or `[^this]:` (in a\n footnote definition) cannot contain whitespace\n* Image and link references cannot start with carets, so `![^this doesn’t\n work][]`, and `[^neither does this][]`\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-breaks`](https://github.com/remarkjs/remark-breaks)\n — More breaks\n* [`remark-frontmatter`](https://github.com/remarkjs/remark-frontmatter)\n — Frontmatter (yaml, toml, and more) support\n* [`remark-github`](https://github.com/remarkjs/remark-github)\n — References to issues, PRs, comments, users, etc\n* [`remark-math`](https://github.com/rokt33r/remark-math)\n — Inline and block math\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://img.shields.io/travis/remarkjs/remark-footnotes/main.svg\n\n[build]: https://travis-ci.org/remarkjs/remark-footnotes\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" }