{"_id":"@benrbray/remark-cite","_rev":"5-af90e398196f167144edfd380c26488d","name":"@benrbray/remark-cite","dist-tags":{"latest":"2.0.1-alpha.4"},"versions":{"1.0.0":{"name":"@benrbray/remark-cite","version":"1.0.0","keywords":["markdown","pandoc","citations","bibliography","remark","remark-plugin","micromark","micromark-plugin","micromark-extension"],"author":{"url":"https://benrbray.com/","name":"Benjamin R. Bray"},"license":"MIT","_id":"@benrbray/remark-cite@1.0.0","maintainers":[{"name":"benrbray","email":"benrbray@gmail.com"}],"homepage":"https://github.com/benrbray/remark-cite#readme","bugs":{"url":"https://github.com/benrbray/remark-cite/issues"},"dist":{"shasum":"c617cfe92ccffb5cc5122e4b92e6a57b3e67400f","tarball":"https://registry.npmjs.org/@benrbray/remark-cite/-/remark-cite-1.0.0.tgz","fileCount":14,"integrity":"sha512-K7H+KDT3WfYhlq83rCiVVAfYqVr8ttbojbkbtbw0JbYNevJv6wr4wh5yX73F54WmOJCyhXqsy13S/RZP5FTs6Q==","signatures":[{"sig":"MEQCIAG1KBAgvbd9k4W91l4ePqMWQTtSqTbPvOSgpm8telTnAiANzeiCH4+AzblNRxYBkwFDhZdGFSkhbX4KEfwkbdaGaA==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":15133,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJglnDeCRA9TVsSAnZWagAAhGQP/AhEwx6rg69dveLRLo62\nveHmI35lxnQra7xyfkAI8X3TyFdBp0RfRt1H7RomYKuCo606r7kKtg6ju3/1\nX/bie8WWwY011g18hLbdBnwy+454wI90TcC7SvZEOp4+1FMaCEruqj9dhueP\nP4Xl1pSI/k8vFBn7v+WNMzr+A1Urll0x7oghE9zsbAHTSivPWJh0ZZLfqxQh\n9DnJHp9cwBWaY4Eql3utKDk3A1Q34vfxSPutVsPa6QdUUvgEZTvcTwiS7NCi\nstdwTd4CY4LbMpcgtE1JXwDuBAca6RVQ4ZkLLaXl87eo/V+VOQumRVuiWkgW\nmrtmpgSo0MnTcDFYXE+EmPJTQ8slAwzN3eDst2WhDTgY1FjxylAmrvZCCb8O\nP3lN5joYBouQFj89F7gJmMbRLh4LCmEa/HXEOA/FNOhcSQFhd5JAGn4XY86Q\n8MbZii8PTGbvxV4OAfOc1lf5IIXNfpLd3sMZlWd4r2sy4+N5zkOU64i2KiEg\nw5U2zAd8DgTzrO1DEls2Ibda+cJgM5spQOABS4y9It95dgPnIGGjGmKtqeUu\nHo51gXbbiMZwumVr6B2nV3VnIH68FiAG1cXH91HVzj0apGPnxKaba3oV26rC\nUbBN2INvRQvKKep8mUeuepZPo5UhU/wH8wu2DcD5H35ynW9uQep+pcUSFPKR\nAMYi\r\n=QnuT\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.cjs.js","module":"dist/index.esm.js","browser":"dist/index.umd.js","scripts":{"test":"env TS_NODE_COMPILER_OPTIONS='{\"module\": \"commonjs\" }' mocha -r ts-node/register 'test/**/*.ts'","build":"rollup -c","clean":"npx del dist","prepare":"npm run clean; npm run build","pretest":"npm run clean; npm run build","dev:fix-links":"npm link @benrbray/micromark-extension-cite @benrbray/mdast-util-cite"},"_npmUser":{"name":"benrbray","email":"benrbray@gmail.com"},"repository":{"url":"git+https://github.com/benrbray/remark-cite.git","type":"git","directory":"remark-cite"},"_npmVersion":"7.11.2","description":"A `remark` plugin for pandoc-style citations.","directories":{},"_nodeVersion":"14.16.1","dependencies":{"@benrbray/mdast-util-cite":"^1.0.1","@benrbray/micromark-extension-cite":"^1.0.0"},"_hasShrinkwrap":false,"devDependencies":{"mocha":"^8.3.2","rollup":"^2.47.0","del-cli":"^3.0.1","ts-node":"^9.1.1","unified":"^9.2.1","@types/mdast":"^3.0.3","@types/mocha":"^8.2.2","@types/unist":"^2.0.3","remark-parse":"^9.0.0","remark-stringify":"^9.0.1","@rollup/plugin-babel":"^5.3.0","@rollup/plugin-commonjs":"^18.1.0","mdast-util-from-markdown":"^0.8.5","@wessberg/rollup-plugin-ts":"^1.3.14","@babel/plugin-transform-runtime":"^7.13.15"},"_npmOperationalInternal":{"tmp":"tmp/remark-cite_1.0.0_1620472029879_0.6344474499534549","host":"s3://npm-registry-packages"}},"1.1.0":{"name":"@benrbray/remark-cite","version":"1.1.0","keywords":["markdown","pandoc","citations","bibliography","remark","remark-plugin","micromark","micromark-plugin","micromark-extension"],"author":{"url":"https://benrbray.com/","name":"Benjamin R. Bray"},"license":"MIT","_id":"@benrbray/remark-cite@1.1.0","maintainers":[{"name":"benrbray","email":"benrbray@gmail.com"}],"homepage":"https://github.com/benrbray/remark-cite#readme","bugs":{"url":"https://github.com/benrbray/remark-cite/issues"},"dist":{"shasum":"05aa2dca2cd9892e395d949a96ad69f95acbfa03","tarball":"https://registry.npmjs.org/@benrbray/remark-cite/-/remark-cite-1.1.0.tgz","fileCount":14,"integrity":"sha512-UOeh0JOyO6JaCGgWimFtBCjXOabLLbGxT72KgQvIQH9MPX3DYGQtks0QAuGRz00raMV5UOK1uL12xMkh4MIlzA==","signatures":[{"sig":"MEUCIQCt2YnsQFpJD22V0YTk8X0eHPKtvqCgvJ9YYzRi02uo7AIgRO2hyJ2+hHIPZeNjFMu10d+ojaCfz1tzOifL+l9pVlc=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":16921,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgpNwICRA9TVsSAnZWagAAdfwP/j1IyC3gqM8nAtrb7fYu\nUC/IhvMoEQIOU3ZMy7pmIymadyVrzstYPQis/nqw52CPYgeK57FdfSopZoSO\ngL38RssXjT1utASy4GsWg/KgHKzqWf2ImyWX5U0Vdc79jidJapGZd8maw1fr\nZJOcS2uJJD+mTEtSFrZFVxu0EqUtqPZzz/I3MyoxHrK5MGy5djaq/ixYvCLF\nvrtN+LIZEqTnj0HgyMEWQZwCOrk5iRE1FPyNIBCGfil5Lj8eNXWNU8X9+f6V\nLpXL/d3gUlPyWaeStMh3oeuhqUbGBFwSVle4HoXYunXgtZhxeeq7gqCBnUMH\n3v5pfBW5qNc8NKXazudoY7+PUMKpH/4UEU1Izvry7nTHjLTKV0JvsaVf9pXO\n5jy+Ya8Gfik0d9AZ2oOR32fgVhuvWdDlZKsfFx2cgk2bV5mlxz4wo1B6NXJF\nObb0YLlEtabPV1WTUFfEqgpuqjK2be51KVRHzVF+cl4u0faX95yCeokTu68c\n8KpCdKbqQYm/9v3PCAY1IjVK0R/CNI9hcheAltP+iSRP8yfJaJjEUorg/Nzh\n3s423keGprXx4dwKyuWxojAvqd6xiyrzDPKGG5mFhCDa6kYKZ0nWKDLKiRw7\nPdawKEBFVyyBbwMLWuv7szDF1j/g0InGsyPsEr0ZQobI/m23nr/MS7qjw4Rc\np1or\r\n=sd3M\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.cjs.js","module":"dist/index.esm.js","browser":"dist/index.umd.js","scripts":{"test":"env TS_NODE_COMPILER_OPTIONS='{\"module\": \"commonjs\" }' mocha -r ts-node/register 'test/**/*.ts'","build":"rollup -c","clean":"npx del dist","prepare":"npm run clean; npm run build","pretest":"npm run clean; npm run build","dev:fix-links":"npm link @benrbray/micromark-extension-cite @benrbray/mdast-util-cite"},"_npmUser":{"name":"benrbray","email":"benrbray@gmail.com"},"repository":{"url":"git+https://github.com/benrbray/remark-cite.git","type":"git","directory":"remark-cite"},"_npmVersion":"7.11.2","description":"A `remark` plugin for pandoc-style citations.","directories":{},"_nodeVersion":"14.17.0","dependencies":{"@benrbray/mdast-util-cite":"^1.0.1","@benrbray/micromark-extension-cite":"^1.0.0"},"_hasShrinkwrap":false,"devDependencies":{"mocha":"^8.3.2","rollup":"^2.47.0","del-cli":"^3.0.1","ts-node":"^9.1.1","unified":"^9.2.1","@types/mdast":"^3.0.3","@types/mocha":"^8.2.2","@types/unist":"^2.0.3","remark-parse":"^9.0.0","remark-stringify":"^9.0.1","@rollup/plugin-babel":"^5.3.0","@rollup/plugin-commonjs":"^18.1.0","mdast-util-from-markdown":"^0.8.5","@wessberg/rollup-plugin-ts":"^1.3.14","@babel/plugin-transform-runtime":"^7.13.15"},"_npmOperationalInternal":{"tmp":"tmp/remark-cite_1.1.0_1621416968117_0.031251926227428894","host":"s3://npm-registry-packages"}},"2.0.0-alpha.0":{"name":"@benrbray/remark-cite","version":"2.0.0-alpha.0","keywords":["markdown","pandoc","citations","bibliography","remark","remark-plugin"],"author":{"url":"https://benrbray.com/","name":"Benjamin R. Bray"},"license":"MIT","_id":"@benrbray/remark-cite@2.0.0-alpha.0","maintainers":[{"name":"benrbray","email":"benrbray@gmail.com"}],"homepage":"https://github.com/benrbray/remark-cite#readme","bugs":{"url":"https://github.com/benrbray/remark-cite/issues"},"dist":{"shasum":"ba5677b8ce8059d62407e01f9ae13cd24723c50e","tarball":"https://registry.npmjs.org/@benrbray/remark-cite/-/remark-cite-2.0.0-alpha.0.tgz","fileCount":5,"integrity":"sha512-AsOvW3SGvbZ4ZZJ7wnU92oLlQkkYLclc/dlumeKGPV2jH8xWDD5/4WIQMnGcAQwhS0PEb8OoRSHQMo8V7yix3Q==","signatures":[{"sig":"MEUCIQDuJXNtV30ypDOLXb5Iw+rYkEu1F4ge+fhA1mTSfHsy9AIgTPZdKAj4HeViGD5lUa02nzydyu/LHp5NglIUKUcvJm0=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":5986},"type":"module","types":"dist/remark-cite.d.ts","exports":{".":"./dist/remark-cite.js"},"gitHead":"71a00ab5a1886a05e2d3ce3178b575bae600e6df","scripts":{"dev":"vite","test":"vitest","build":"tsc && vite build","clean":"pnpm del dist","prepare":"pnpm run clean; pnpm run build","pretest":"pnpm run clean; pnpm run build","preview":"vite preview"},"_npmUser":{"name":"benrbray","email":"benrbray@gmail.com"},"repository":{"url":"git+https://github.com/benrbray/remark-cite.git","type":"git","directory":"remark-cite"},"_npmVersion":"10.4.0","description":"A `remark` plugin for pandoc-style citations.","directories":{},"_nodeVersion":"20.11.1","dependencies":{"@benrbray/mdast-util-cite":"workspace:^2.0.0-alpha.0","@benrbray/micromark-extension-cite":"workspace:^2.0.0-alpha.0"},"_hasShrinkwrap":false,"devDependencies":{"vite":"^5.2.0","vitest":"^1.6.0","del-cli":"^5.1.0","unified":"^11.0.4","typescript":"^5.2.2","@types/mdast":"^4.0.4","@types/unist":"^3.0.2","remark-parse":"^11.0.0","vite-plugin-dts":"^3.9.1","remark-stringify":"^11.0.0","vite-tsconfig-paths":"^4.3.2","micromark-util-types":"^2.0.0","mdast-util-to-markdown":"^2.1.0","mdast-util-from-markdown":"^2.0.1"},"_npmOperationalInternal":{"tmp":"tmp/remark-cite_2.0.0-alpha.0_1720626757427_0.32264260024953173","host":"s3://npm-registry-packages"}},"2.0.1-alpha.2":{"name":"@benrbray/remark-cite","version":"2.0.1-alpha.2","keywords":["markdown","pandoc","citations","bibliography","remark","remark-plugin"],"author":{"url":"https://benrbray.com/","name":"Benjamin R. Bray"},"license":"MIT","_id":"@benrbray/remark-cite@2.0.1-alpha.2","maintainers":[{"name":"benrbray","email":"benrbray@gmail.com"}],"homepage":"https://github.com/benrbray/remark-cite#readme","bugs":{"url":"https://github.com/benrbray/remark-cite/issues"},"dist":{"shasum":"185df98819735fe1b081fc64ddc7192d13f83245","tarball":"https://registry.npmjs.org/@benrbray/remark-cite/-/remark-cite-2.0.1-alpha.2.tgz","fileCount":6,"integrity":"sha512-USNyCcXn6OWTeGDORDxXmc8btzCPVKODA+Om8k2uCLLsIB1xyxMwybTWp8PxsrmOjb0/Fy4A8Aodw3zA+bHF+Q==","signatures":[{"sig":"MEYCIQCeE7LD3ZwOOKhaE8CKl0OGO2gq7sk+8ujY0QR5SJoKIQIhANFOJLQIr1waeSTNonc/3/eQe4Ax1nCYC5vnpwP4vc6w","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":7037},"type":"module","_from":"file:benrbray-remark-cite-2.0.1-alpha.2.tgz","types":"dist/remark-cite.d.ts","exports":{".":"./dist/remark-cite.js"},"scripts":{"dev":"vite","test":"vitest","build":"tsc && vite build","clean":"pnpm del dist","pretest":"pnpm run clean; pnpm run build","preview":"vite preview","publish-pnpm":"pnpm publish"},"_npmUser":{"name":"benrbray","email":"benrbray@gmail.com"},"_resolved":"/tmp/9fcd07b96efa1c45979328684e041646/benrbray-remark-cite-2.0.1-alpha.2.tgz","_integrity":"sha512-USNyCcXn6OWTeGDORDxXmc8btzCPVKODA+Om8k2uCLLsIB1xyxMwybTWp8PxsrmOjb0/Fy4A8Aodw3zA+bHF+Q==","repository":{"url":"git+https://github.com/benrbray/remark-cite.git","type":"git","directory":"remark-cite"},"_npmVersion":"10.4.0","description":"A `remark` plugin for pandoc-style citations.","directories":{},"_nodeVersion":"20.11.1","dependencies":{"@benrbray/mdast-util-cite":"^2.0.1-alpha.0","@benrbray/micromark-extension-cite":"^2.0.1-alpha.0"},"_hasShrinkwrap":false,"devDependencies":{"vite":"^5.2.0","vitest":"^1.6.0","del-cli":"^5.1.0","unified":"^11.0.4","typescript":"^5.2.2","@types/mdast":"^4.0.4","@types/unist":"^3.0.2","remark-parse":"^11.0.0","vite-plugin-dts":"^3.9.1","remark-stringify":"^11.0.0","vite-tsconfig-paths":"^4.3.2","micromark-util-types":"^2.0.0","mdast-util-to-markdown":"^2.1.0","mdast-util-from-markdown":"^2.0.1"},"_npmOperationalInternal":{"tmp":"tmp/remark-cite_2.0.1-alpha.2_1720628725288_0.3616016329160605","host":"s3://npm-registry-packages"}},"2.0.1-alpha.4":{"name":"@benrbray/remark-cite","version":"2.0.1-alpha.4","license":"MIT","description":"A `remark` plugin for pandoc-style citations.","repository":{"type":"git","url":"git+https://github.com/benrbray/remark-cite.git","directory":"remark-cite"},"keywords":["markdown","pandoc","citations","bibliography","remark","remark-plugin"],"author":{"name":"Benjamin R. Bray","url":"https://benrbray.com/"},"type":"module","exports":{".":"./dist/remark-cite.js"},"types":"dist/remark-cite.d.ts","dependencies":{"@benrbray/mdast-util-cite":"2.0.1-alpha.4","@benrbray/micromark-extension-cite":"2.0.1-alpha.1"},"devDependencies":{"@types/mdast":"^4.0.4","@types/unist":"^3.0.2","del-cli":"^5.1.0","mdast-util-from-markdown":"^2.0.1","mdast-util-to-markdown":"^2.1.0","micromark-util-types":"^2.0.0","remark-parse":"^11.0.0","remark-stringify":"^11.0.0","typescript":"^5.2.2","unified":"^11.0.4","vite":"^5.2.0","vite-plugin-dts":"^3.9.1","vite-tsconfig-paths":"^4.3.2","vitest":"^1.6.0"},"scripts":{"dev":"vite","build":"tsc && vite build","clean":"pnpm del dist","pretest":"pnpm run clean; pnpm run build","preview":"vite preview","test":"vitest","publish-pnpm":"pnpm publish"},"bugs":{"url":"https://github.com/benrbray/remark-cite/issues"},"homepage":"https://github.com/benrbray/remark-cite#readme","_id":"@benrbray/remark-cite@2.0.1-alpha.4","_integrity":"sha512-2rtDjtvIYn88MF5jJ8Qyv0NHxbTac19c+lRKIsHRqnWQcuBehYKmJSt4NWC9TSYd5S8TmgGFYz6md4r4vEJuFw==","_resolved":"/tmp/cc6879e4dd6ee928a808b4a472786372/benrbray-remark-cite-2.0.1-alpha.4.tgz","_from":"file:benrbray-remark-cite-2.0.1-alpha.4.tgz","_nodeVersion":"20.11.1","_npmVersion":"10.4.0","dist":{"integrity":"sha512-2rtDjtvIYn88MF5jJ8Qyv0NHxbTac19c+lRKIsHRqnWQcuBehYKmJSt4NWC9TSYd5S8TmgGFYz6md4r4vEJuFw==","shasum":"9eaf1df54354a40cb08e6bd64339eeba04f4ae03","tarball":"https://registry.npmjs.org/@benrbray/remark-cite/-/remark-cite-2.0.1-alpha.4.tgz","fileCount":6,"unpackedSize":7035,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIAJEVBs3b2FZT3qw/TTDeHHAlDOcOcDQwngbpIjQiMJ+AiEA/TKzsUy2qR3Adqc7plhRk6UY8HB/96vWaIj/Q902MRY="}]},"_npmUser":{"name":"benrbray","email":"benrbray@gmail.com"},"directories":{},"maintainers":[{"name":"benrbray","email":"benrbray@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/remark-cite_2.0.1-alpha.4_1720685685796_0.24373274029767789"},"_hasShrinkwrap":false}},"time":{"created":"2021-05-08T11:07:09.800Z","modified":"2024-07-11T08:14:46.114Z","1.0.0":"2021-05-08T11:07:10.013Z","1.1.0":"2021-05-19T09:36:08.266Z","2.0.0-alpha.0":"2024-07-10T15:52:37.571Z","2.0.1-alpha.2":"2024-07-10T16:25:25.403Z","2.0.1-alpha.4":"2024-07-11T08:14:45.943Z"},"bugs":{"url":"https://github.com/benrbray/remark-cite/issues"},"author":{"name":"Benjamin R. Bray","url":"https://benrbray.com/"},"license":"MIT","homepage":"https://github.com/benrbray/remark-cite#readme","keywords":["markdown","pandoc","citations","bibliography","remark","remark-plugin"],"repository":{"type":"git","url":"git+https://github.com/benrbray/remark-cite.git","directory":"remark-cite"},"description":"A `remark` plugin for pandoc-style citations.","maintainers":[{"name":"benrbray","email":"benrbray@gmail.com"}],"readme":"# `remark-cite`\n\n[![](https://img.shields.io/npm/v/@benrbray/remark-cite?style=flat-square)](https://www.npmjs.com/package/@benrbray/remark-cite)\n![license](https://img.shields.io/github/license/benrbray/remark-cite?style=flat-square)\n\nPlugin for [`remark`](https://github.com/remarkjs/remark) to support [`pandoc`-style](https://pandoc.org/MANUAL.html#extension-citations) citations.  Relies on [`micromark-extension-cite`](https://github.com/benrbray/remark-cite/tree/master/micromark-extension-cite) for tokenization and [`mdast-util-cite`](https://github.com/benrbray/remark-cite/tree/master/mdast-util-cite) for converting markdown to/from abstract syntax trees.\n\nNote that this extension only parses the input -- it is up to you to assign meaning to these citations by looking up each key in a `.bibtex` file or other tagged citation database.\n\n## Install\n\nInstall [`@benrbray/remark-cite`]() on `npm`.\n\n```\nnpm install @benrbray/remark-cite\n```\n\n## Usage\n\n```javascript\nconst unified = require('unified')\nconst markdown = require('remark-parse')\nconst { citePlugin } = require('@benrbray/remark-cite');\n\nlet defaultOptions = {\n\tsyntax: {\n\t\t// see micromark-extension-cite\n\t\tenableAltSyntax: false,\n\t\tenablePandocSyntax: true,\n\t},\n\ttoMarkdown: {\n\t\t// see mdast-util-cite\n\t\tstandardizeAltSyntax: false,\n\t\tenableAuthorSuppression: true,\n\t\tuseNodeValue: false\n\t}\n};\n\nlet processor = unified()\n    .use(markdown)\n    .use(citePlugin, {})\n```\n\nRunning the processor on the following markdown:\n\n```\n[see @wadler1989, sec. 1.3; and -@hughes1990, pp.4]\n```\n\nWill produce the following `cite` node:\n\n```json\n{\n\t\"type\": \"cite\",\n\t\"value\": \"[see @wadler1989, sec. 1.3; and -@hughes1990, pp.4]\",\n\t\"data\": {\n\t\t\"citeItems\": [\n\t\t\t{\n\t\t\t\t\"prefix\": \"see \",\n\t\t\t\t\"key\": \"wadler1989\",\n\t\t\t\t\"suffix\": \", sec. 1.3\"\n\t\t\t},{\n\t\t\t\t\"prefix\": \" and \",\n\t\t\t\t\"suppressAuthor\": true,\n\t\t\t\t\"key\": \"hughes1990\",\n\t\t\t\t\"suffix\": \", pp.4\"\n\t\t\t}\n\t\t]\n\t}\n}\n```\n\n### Configuration\n\nFor details about the **syntax tree** structure, see [`mdast-util-cite`](https://github.com/benrbray/remark-cite/tree/master/mdast-util-cite).  For details about the **configuration** and supported **syntax**, see [`micromark-extension-cite`](https://github.com/benrbray/remark-cite/tree/master/micromark-extension-cite).\n","readmeFilename":"README.md"}