{"_id":"mdast-util-gfm-footnote","_rev":"7-917eb9d8f238e6ce9080d7a8d99fe196","name":"mdast-util-gfm-footnote","dist-tags":{"latest":"2.1.0"},"versions":{"1.0.0":{"name":"mdast-util-gfm-footnote","version":"1.0.0","keywords":["unist","mdast","mdast-util","util","utility","markdown","markup","gfm","footnote","note"],"author":{"url":"https://wooorm.com","name":"Titus Wormer","email":"tituswormer@gmail.com"},"license":"MIT","_id":"mdast-util-gfm-footnote@1.0.0","maintainers":[{"name":"wooorm","email":"tituswormer@gmail.com"}],"contributors":[{"url":"https://wooorm.com","name":"Titus Wormer","email":"tituswormer@gmail.com"}],"homepage":"https://github.com/syntax-tree/mdast-util-gfm-footnote#readme","bugs":{"url":"https://github.com/syntax-tree/mdast-util-gfm-footnote/issues"},"xo":{"prettier":true},"dist":{"shasum":"355c1e8dc9e17e871d1b3fa5da8824923fc756e0","tarball":"https://registry.npmjs.org/mdast-util-gfm-footnote/-/mdast-util-gfm-footnote-1.0.0.tgz","fileCount":5,"integrity":"sha512-qeg9YoS2YYP6OBmMyUFxKXb6BLwAsbGidIxgwDAXHIMYZQhIwe52L9BSJs+zP29Jp5nSERPkmG3tSwAN23/ZbQ==","signatures":[{"sig":"MEUCIQDkIzOrYPI1Ol7QucGueOVqs+5TwQpaBdb1Vy9oiuAmVQIgZTNQYNqhsnKNdlIsN4cHH3QmxVcIW2zTZdkWMX3U+jE=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":14678},"main":"index.js","type":"module","types":"index.d.ts","funding":{"url":"https://opencollective.com/unified","type":"opencollective"},"gitHead":"bd86439585ec9ededaea5ed45793c7f07cdd45b1","scripts":{"test":"npm run build && npm run format && npm run test-coverage","build":"rimraf \"*.d.ts\" && tsc && type-coverage","format":"remark . -qfo && prettier . -w --loglevel warn && xo --fix","test-api":"node --conditions development test.js","test-coverage":"c8 --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 --reporter lcov node --conditions development test.js"},"_npmUser":{"name":"wooorm","email":"tituswormer@gmail.com"},"prettier":{"semi":false,"useTabs":false,"tabWidth":2,"singleQuote":true,"trailingComma":"none","bracketSpacing":false},"repository":{"url":"git+https://github.com/syntax-tree/mdast-util-gfm-footnote.git","type":"git"},"_npmVersion":"7.23.0","description":"mdast extension to parse and serialize GFM footnotes","directories":{},"sideEffects":false,"_nodeVersion":"16.9.0","dependencies":{"@types/mdast":"^3.0.0","unist-util-visit":"^4.0.0","mdast-util-to-markdown":"^1.0.0","micromark-util-normalize-identifier":"^1.0.0"},"remarkConfig":{"plugins":["preset-wooorm"]},"typeCoverage":{"detail":true,"strict":true,"atLeast":100,"ignoreCatch":true},"_hasShrinkwrap":false,"devDependencies":{"c8":"^7.0.0","xo":"^0.45.0","tape":"^5.0.0","rimraf":"^3.0.0","prettier":"^2.0.0","remark-cli":"^10.0.0","typescript":"^4.0.0","@types/tape":"^4.0.0","type-coverage":"^2.0.0","remark-preset-wooorm":"^9.0.0","mdast-util-from-markdown":"^1.0.0","micromark-extension-gfm-footnote":"^1.0.0"},"_npmOperationalInternal":{"tmp":"tmp/mdast-util-gfm-footnote_1.0.0_1633252146065_0.2145107236197621","host":"s3://npm-registry-packages"}},"1.0.1":{"name":"mdast-util-gfm-footnote","version":"1.0.1","keywords":["unist","mdast","mdast-util","util","utility","markdown","markup","gfm","footnote","note"],"author":{"url":"https://wooorm.com","name":"Titus Wormer","email":"tituswormer@gmail.com"},"license":"MIT","_id":"mdast-util-gfm-footnote@1.0.1","maintainers":[{"name":"wooorm","email":"tituswormer@gmail.com"},{"name":"kmck","email":"keith@mcknig.ht"}],"contributors":[{"url":"https://wooorm.com","name":"Titus Wormer","email":"tituswormer@gmail.com"}],"homepage":"https://github.com/syntax-tree/mdast-util-gfm-footnote#readme","bugs":{"url":"https://github.com/syntax-tree/mdast-util-gfm-footnote/issues"},"xo":{"prettier":true},"dist":{"shasum":"11d2d40a1a673a399c459e467fa85e00223191fe","tarball":"https://registry.npmjs.org/mdast-util-gfm-footnote/-/mdast-util-gfm-footnote-1.0.1.tgz","fileCount":5,"integrity":"sha512-p+PrYlkw9DeCRkTVw1duWqPRHX6Ywh2BNKJQcZbCwAuP/59B0Lk9kakuAd7KbQprVO4GzdW8eS5++A9PUSqIyw==","signatures":[{"sig":"MEQCIFAEz5IVFEuAa1mdhuCS/KSl+pjKVE5s9SwbCJ9AnWODAiAPnMauSBCpkTRJDKbfJhsleGP137KOU64HDvzJ6YXHqw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":14278,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh9/6qCRA9TVsSAnZWagAAUkMQAJD1qfJnR0F9Rdew94W0\ncJhwv8UYqhWZforaMSlFV/L34LvgZ4HL+BXGr9UYPLZ8AQDZzaYNXK0pOu8z\n1XFjZjwvAYDdvKu8rvgVxYYAwyVPhptHRUgBbWaeRTUIn7rsQO5080nj+n74\nTXR02MeKHnDSlJCVLfjpWOypuvGaS59EgZEGCf7XRCgM4xb0LTZbEq+KQB1S\n18bl6z6+wqa8O9Ss7uPhzdGuPZ3Pd+BMslk8E5nucIKcXHFlu1ayzMnO96ek\nn+13/nAeYVkLdyplnbWzhbby7sIAIqYKIGRelKpOKtlj1umMbVnp/qdoaTqR\nQVaeAspktWrbrcWw+rEflqr71+Ik8YyJA4FzYN/aVjQspXOomZiNOZQzc09m\ngBfQDY+99c2AqJBNmTHp9L9nKw1JWx5bR6NtR72Bdu9p3Q9GbFtYB2shqq+e\nMJLoD64qSxQmSsRvmWixSncLPdqfQoJWff0JVYcgnQFsqGxzEq11p+hrgECX\nN+NQXjcWNM9UGwcqChSXoBeKODkAbIGUgZ9aPgwg8Hx76cSv9IEEEK4Ls2f6\nPGE5JN/UBcUOWK9t2Nf2OcIhlGz/2Zuv6+jSBHvaKjmrteS57E2qKaVRfnrC\nW65myiv768bC8pLd1++dA69ILz74MSf08WaaqGiR/YTdSJ5A7rXjvRHVdDpf\nlAl1\r\n=vxdn\r\n-----END PGP SIGNATURE-----\r\n"},"main":"index.js","type":"module","types":"index.d.ts","funding":{"url":"https://opencollective.com/unified","type":"opencollective"},"gitHead":"e100ffdd8e3741a25d6f9e839c6c7eb106e25c95","scripts":{"test":"npm run build && npm run format && npm run test-coverage","build":"rimraf \"*.d.ts\" && tsc && type-coverage","format":"remark . -qfo && prettier . -w --loglevel warn && xo --fix","test-api":"node --conditions development test.js","test-coverage":"c8 --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 --reporter lcov node --conditions development test.js"},"_npmUser":{"name":"wooorm","email":"tituswormer@gmail.com"},"prettier":{"semi":false,"useTabs":false,"tabWidth":2,"singleQuote":true,"trailingComma":"none","bracketSpacing":false},"repository":{"url":"git+https://github.com/syntax-tree/mdast-util-gfm-footnote.git","type":"git"},"_npmVersion":"8.3.1","description":"mdast extension to parse and serialize GFM footnotes","directories":{},"sideEffects":false,"_nodeVersion":"17.4.0","dependencies":{"@types/mdast":"^3.0.0","mdast-util-to-markdown":"^1.3.0","micromark-util-normalize-identifier":"^1.0.0"},"remarkConfig":{"plugins":["preset-wooorm"]},"typeCoverage":{"detail":true,"strict":true,"atLeast":100,"ignoreCatch":true},"_hasShrinkwrap":false,"devDependencies":{"c8":"^7.0.0","xo":"^0.47.0","tape":"^5.0.0","rimraf":"^3.0.0","prettier":"^2.0.0","remark-cli":"^10.0.0","typescript":"^4.0.0","@types/tape":"^4.0.0","type-coverage":"^2.0.0","remark-preset-wooorm":"^9.0.0","mdast-util-from-markdown":"^1.0.0","micromark-extension-gfm-footnote":"^1.0.0"},"_npmOperationalInternal":{"tmp":"tmp/mdast-util-gfm-footnote_1.0.1_1643642537967_0.9194172328614667","host":"s3://npm-registry-packages"}},"1.0.2":{"name":"mdast-util-gfm-footnote","version":"1.0.2","keywords":["unist","mdast","mdast-util","util","utility","markdown","markup","gfm","footnote","note"],"author":{"url":"https://wooorm.com","name":"Titus Wormer","email":"tituswormer@gmail.com"},"license":"MIT","_id":"mdast-util-gfm-footnote@1.0.2","maintainers":[{"name":"wooorm","email":"tituswormer@gmail.com"},{"name":"kmck","email":"keith@mcknig.ht"}],"contributors":[{"url":"https://wooorm.com","name":"Titus Wormer","email":"tituswormer@gmail.com"}],"homepage":"https://github.com/syntax-tree/mdast-util-gfm-footnote#readme","bugs":{"url":"https://github.com/syntax-tree/mdast-util-gfm-footnote/issues"},"xo":{"prettier":true},"dist":{"shasum":"ce5e49b639c44de68d5bf5399877a14d5020424e","tarball":"https://registry.npmjs.org/mdast-util-gfm-footnote/-/mdast-util-gfm-footnote-1.0.2.tgz","fileCount":7,"integrity":"sha512-56D19KOGbE00uKVj3sgIykpwKL179QsVFwx/DCW0u/0+URsryacI4MAdNJl0dh+u2PSsD9FtxPFbHCzJ78qJFQ==","signatures":[{"sig":"MEUCIQCurcKTnfKNoTAnQBSK+xYrB60aBjxEfykxWxeu5cP9hAIgWEN6LWK++2EVVUSoFBUWXMCcL7jDkm85F8fu+xqkF+4=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":21598,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJj1UbOACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpppRAAmCw0oEFbpsKktZvVsyRvBtB14sMIp3eA3mBeVrkC+7KRP7Ja\r\nN123npfXMmNf7GIXrrO8c7hPbN60j8Ypi1/9YOoGU8mYTxehi34td7J4bo+8\r\nEzKBzl9dDZ2DSUfir9yhIsm5ZMNbrMo9UZu67wmq6WqitxdS12jvtcR3WQVz\r\nx7AbxfdqcxG1NZhjcs1e6dKv13zWGBKiBgQSqRgr/y/u4Q8z4y/Ym13cC6tq\r\nXZYxRHIoyZt770xLRutVcuvZJCUYmFRh7NxgCaugn9nR0GG4uHT5xViqfmMm\r\nsThl0+gVMrPEfNnSh5RnWgYks0tC8OuDwL+QFDY7XGWxCvBk4p4+hRjY6E6B\r\nWaPY2RDemWfh8/hclmtUe/RTJswy9TNk6oazPJGVlXX3Mt4fr9qDfrDTeMJk\r\niq5hqXXF0Os6sZ6frtOcAMjOBlHNxZ1CeVHtprUGmlB3vhMNbkf0UENHyb+Z\r\npkIRzf9zJ3w+/+dvdid26Qo8CKHN7uFErx+8HxAo9wr/5yiybVXx8wRZz8dl\r\nHsnAC2ix22ECmCGeWGmtWhrRF1vHMBSSjVWNcoVP8WUGjj4Y8hQAR1MlmL4A\r\nNwxdi3ThnRCrQCFgngltu93IJzvWULBEvl41g7PMqSFUj3oNb06b7vKCMKR9\r\njoSMn8XPxgP4z5OGgM/BMZ5NuLGKiWYHpVo=\r\n=guXd\r\n-----END PGP SIGNATURE-----\r\n"},"main":"index.js","type":"module","types":"index.d.ts","funding":{"url":"https://opencollective.com/unified","type":"opencollective"},"gitHead":"50f37ca7114dcdc5d0305b73ccb059c65e94abea","scripts":{"test":"npm run build && npm run format && npm run test-coverage","build":"tsc --build --clean && tsc --build && type-coverage","format":"remark . -qfo && prettier . -w --loglevel warn && xo --fix","prepack":"npm run build && npm run format","test-api":"node --conditions development test.js","test-coverage":"c8 --check-coverage --100 --reporter lcov npm run test-api"},"_npmUser":{"name":"wooorm","email":"tituswormer@gmail.com"},"prettier":{"semi":false,"useTabs":false,"tabWidth":2,"singleQuote":true,"trailingComma":"none","bracketSpacing":false},"repository":{"url":"git+https://github.com/syntax-tree/mdast-util-gfm-footnote.git","type":"git"},"_npmVersion":"9.2.0","description":"mdast extension to parse and serialize GFM footnotes","directories":{},"sideEffects":false,"_nodeVersion":"19.3.0","dependencies":{"@types/mdast":"^3.0.0","mdast-util-to-markdown":"^1.3.0","micromark-util-normalize-identifier":"^1.0.0"},"remarkConfig":{"plugins":["preset-wooorm"]},"typeCoverage":{"detail":true,"strict":true,"atLeast":100,"ignoreCatch":true},"_hasShrinkwrap":false,"devDependencies":{"c8":"^7.0.0","xo":"^0.53.0","prettier":"^2.0.0","remark-cli":"^11.0.0","typescript":"^4.0.0","@types/node":"^18.0.0","type-coverage":"^2.0.0","remark-preset-wooorm":"^9.0.0","mdast-util-from-markdown":"^1.0.0","micromark-extension-gfm-footnote":"^1.0.0"},"_npmOperationalInternal":{"tmp":"tmp/mdast-util-gfm-footnote_1.0.2_1674921678114_0.33176520024135003","host":"s3://npm-registry-packages"}},"2.0.0":{"name":"mdast-util-gfm-footnote","version":"2.0.0","keywords":["unist","mdast","mdast-util","util","utility","markdown","markup","gfm","footnote","note"],"author":{"url":"https://wooorm.com","name":"Titus Wormer","email":"tituswormer@gmail.com"},"license":"MIT","_id":"mdast-util-gfm-footnote@2.0.0","maintainers":[{"name":"wooorm","email":"tituswormer@gmail.com"},{"name":"kmck","email":"keith@mcknig.ht"}],"contributors":[{"url":"https://wooorm.com","name":"Titus Wormer","email":"tituswormer@gmail.com"}],"homepage":"https://github.com/syntax-tree/mdast-util-gfm-footnote#readme","bugs":{"url":"https://github.com/syntax-tree/mdast-util-gfm-footnote/issues"},"xo":{"prettier":true,"overrides":[{"files":["**/*.ts"],"rules":{"@typescript-eslint/consistent-type-definitions":"off"}}]},"dist":{"shasum":"25a1753c7d16db8bfd53cd84fe50562bd1e6d6a9","tarball":"https://registry.npmjs.org/mdast-util-gfm-footnote/-/mdast-util-gfm-footnote-2.0.0.tgz","fileCount":7,"integrity":"sha512-5jOT2boTSVkMnQ7LTrd6n/18kqwjmuYqo7JUPe+tRCY6O7dAuTFMtTPauYYrMPpox9hlN0uOx/FL8XvEfG9/mQ==","signatures":[{"sig":"MEQCIB1Ysyi6EKvo9AQl2VgeuXlZdVMsBan9kyYyq8yfCgREAiBe8XzFRGBAdmpkP0ngUFiMKT6Q5vzDyW8G/ybI6WxSww==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":21387},"type":"module","types":"./index.d.ts","exports":"./index.js","funding":{"url":"https://opencollective.com/unified","type":"opencollective"},"gitHead":"d6826c6addd639dd09abc8529fa4283f67eecc31","scripts":{"test":"npm run build && npm run format && npm run test-coverage","build":"tsc --build --clean && tsc --build && type-coverage","format":"remark . -qfo && prettier . -w --loglevel warn && xo --fix","prepack":"npm run build && npm run format","test-api":"npm run test-api-dev && npm run test-api-prod","test-api-dev":"node --conditions development test.js","test-api-prod":"node --conditions production test.js","test-coverage":"c8 --100 --reporter lcov npm run test-api"},"_npmUser":{"name":"wooorm","email":"tituswormer@gmail.com"},"prettier":{"semi":false,"useTabs":false,"tabWidth":2,"singleQuote":true,"trailingComma":"none","bracketSpacing":false},"repository":{"url":"git+https://github.com/syntax-tree/mdast-util-gfm-footnote.git","type":"git"},"_npmVersion":"9.7.2","description":"mdast extension to parse and serialize GFM footnotes","directories":{},"sideEffects":false,"_nodeVersion":"20.0.0","dependencies":{"devlop":"^1.1.0","@types/mdast":"^4.0.0","mdast-util-to-markdown":"^2.0.0","mdast-util-from-markdown":"^2.0.0","micromark-util-normalize-identifier":"^2.0.0"},"remarkConfig":{"plugins":["remark-preset-wooorm"]},"typeCoverage":{"detail":true,"strict":true,"atLeast":100,"ignoreCatch":true},"_hasShrinkwrap":false,"devDependencies":{"c8":"^8.0.0","xo":"^0.54.0","prettier":"^2.0.0","remark-cli":"^11.0.0","typescript":"^5.0.0","@types/node":"^20.0.0","type-coverage":"^2.0.0","remark-preset-wooorm":"^9.0.0","micromark-extension-gfm-footnote":"^2.0.0"},"_npmOperationalInternal":{"tmp":"tmp/mdast-util-gfm-footnote_2.0.0_1688988087978_0.4590436838514793","host":"s3://npm-registry-packages"}},"2.1.0":{"author":{"name":"Titus Wormer","email":"tituswormer@gmail.com","url":"https://wooorm.com"},"bugs":{"url":"https://github.com/syntax-tree/mdast-util-gfm-footnote/issues"},"contributors":[{"name":"Titus Wormer","email":"tituswormer@gmail.com","url":"https://wooorm.com"}],"dependencies":{"@types/mdast":"^4.0.0","devlop":"^1.1.0","mdast-util-from-markdown":"^2.0.0","mdast-util-to-markdown":"^2.0.0","micromark-util-normalize-identifier":"^2.0.0"},"description":"mdast extension to parse and serialize GFM footnotes","devDependencies":{"@types/node":"^22.0.0","c8":"^10.0.0","micromark-extension-gfm-footnote":"^2.0.0","prettier":"^3.0.0","remark-cli":"^12.0.0","remark-preset-wooorm":"^11.0.0","type-coverage":"^2.0.0","typescript":"^5.0.0","xo":"^0.60.0"},"exports":"./index.js","funding":{"type":"opencollective","url":"https://opencollective.com/unified"},"keywords":["footnote","gfm","markdown","markup","mdast-util","mdast","note","unist","utility","util"],"license":"MIT","name":"mdast-util-gfm-footnote","prettier":{"bracketSpacing":false,"semi":false,"singleQuote":true,"tabWidth":2,"trailingComma":"none","useTabs":false},"remarkConfig":{"plugins":["remark-preset-wooorm"]},"repository":{"type":"git","url":"git+https://github.com/syntax-tree/mdast-util-gfm-footnote.git"},"scripts":{"build":"tsc --build --clean && tsc --build && type-coverage","format":"remark --frail --output --quiet -- . && prettier --log-level warn --write -- . && xo --fix","test-api-dev":"node --conditions development test.js","test-api-prod":"node --conditions production test.js","test-api":"npm run test-api-dev && npm run test-api-prod","test-coverage":"c8 --100 --reporter lcov npm run test-api","test":"npm run build && npm run format && npm run test-coverage"},"sideEffects":false,"typeCoverage":{"atLeast":100,"strict":true},"type":"module","version":"2.1.0","xo":{"overrides":[{"files":["**/*.d.ts"],"rules":{"@typescript-eslint/array-type":["error",{"default":"generic"}],"@typescript-eslint/ban-types":["error",{"extendDefaults":true}],"@typescript-eslint/consistent-type-definitions":["error","interface"]}}],"prettier":true,"rules":{"unicorn/prefer-at":"off"}},"_id":"mdast-util-gfm-footnote@2.1.0","gitHead":"8ff7529028c33d336caa3ea0af2db19001157f96","types":"./index.d.ts","homepage":"https://github.com/syntax-tree/mdast-util-gfm-footnote#readme","_nodeVersion":"23.1.0","_npmVersion":"11.1.0","dist":{"integrity":"sha512-sqpDWlsHn7Ac9GNZQMeUzPQSMzR6Wv0WKRNvQRg0KqHh02fpTz69Qc1QSseNX29bhz1ROIyNyxExfawVKTm1GQ==","shasum":"7778e9d9ca3df7238cc2bd3fa2b1bf6a65b19403","tarball":"https://registry.npmjs.org/mdast-util-gfm-footnote/-/mdast-util-gfm-footnote-2.1.0.tgz","fileCount":8,"unpackedSize":24051,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQCLWiDFPqXJH90UKrs1CwSQw58sN2iDjyTQsvAZUUbGtwIhAKNMWvyU3tT0/lgXatWDBnqMLOAFPT1L5iYKJtcV4cIJ"}]},"_npmUser":{"name":"wooorm","email":"tituswormer@gmail.com"},"directories":{},"maintainers":[{"name":"wooorm","email":"tituswormer@gmail.com"},{"name":"kmck","email":"keith@mcknig.ht"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/mdast-util-gfm-footnote_2.1.0_1739188342960_0.24898582389844237"},"_hasShrinkwrap":false}},"time":{"created":"2021-10-03T09:09:06.065Z","modified":"2025-02-10T11:52:23.488Z","1.0.0":"2021-10-03T09:09:06.191Z","1.0.1":"2022-01-31T15:22:18.099Z","1.0.2":"2023-01-28T16:01:18.278Z","2.0.0":"2023-07-10T11:21:28.159Z","2.1.0":"2025-02-10T11:52:23.193Z"},"bugs":{"url":"https://github.com/syntax-tree/mdast-util-gfm-footnote/issues"},"author":{"name":"Titus Wormer","email":"tituswormer@gmail.com","url":"https://wooorm.com"},"license":"MIT","homepage":"https://github.com/syntax-tree/mdast-util-gfm-footnote#readme","keywords":["footnote","gfm","markdown","markup","mdast-util","mdast","note","unist","utility","util"],"repository":{"type":"git","url":"git+https://github.com/syntax-tree/mdast-util-gfm-footnote.git"},"description":"mdast extension to parse and serialize GFM footnotes","contributors":[{"name":"Titus Wormer","email":"tituswormer@gmail.com","url":"https://wooorm.com"}],"maintainers":[{"name":"wooorm","email":"tituswormer@gmail.com"},{"name":"kmck","email":"keith@mcknig.ht"}],"readme":"# mdast-util-gfm-footnote\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[mdast][] extensions to parse and serialize [GFM][] footnotes.\n\n## Contents\n\n* [What is this?](#what-is-this)\n* [When to use this](#when-to-use-this)\n* [Install](#install)\n* [Use](#use)\n* [API](#api)\n  * [`gfmFootnoteFromMarkdown()`](#gfmfootnotefrommarkdown)\n  * [`gfmFootnoteToMarkdown(options?)`](#gfmfootnotetomarkdownoptions)\n  * [`ToMarkdownOptions`](#tomarkdownoptions)\n* [HTML](#html)\n* [Syntax](#syntax)\n* [Syntax tree](#syntax-tree)\n  * [Nodes](#nodes)\n  * [Content model](#content-model)\n* [Types](#types)\n* [Compatibility](#compatibility)\n* [Related](#related)\n* [Contribute](#contribute)\n* [License](#license)\n\n## What is this?\n\nThis package contains two extensions that add support for GFM footnote syntax\nin markdown to [mdast][].\nThese extensions plug into\n[`mdast-util-from-markdown`][mdast-util-from-markdown] (to support parsing\nfootnotes in markdown into a syntax tree) and\n[`mdast-util-to-markdown`][mdast-util-to-markdown] (to support serializing\nfootnotes in syntax trees to markdown).\n\nGFM footnotes were [announced September 30, 2021][post] but are not specified.\nTheir implementation on github.com is currently buggy.\nThe bugs have been reported on [`cmark-gfm`][cmark-gfm].\n\n## When to use this\n\nYou can use these extensions when you are working with\n`mdast-util-from-markdown` and `mdast-util-to-markdown` already.\n\nWhen working with `mdast-util-from-markdown`, you must combine this package\nwith [`micromark-extension-gfm-footnote`][micromark-extension-gfm-footnote].\n\nWhen you don’t need a syntax tree, you can use [`micromark`][micromark]\ndirectly with `micromark-extension-gfm-footnote`.\n\nWhen you are working with syntax trees and want all of GFM, use\n[`mdast-util-gfm`][mdast-util-gfm] instead.\n\nAll these packages are used [`remark-gfm`][remark-gfm], which\nfocusses on making it easier to transform content by abstracting these\ninternals away.\n\nThis utility does not handle how markdown is turned to HTML.\nThat’s done by [`mdast-util-to-hast`][mdast-util-to-hast].\nIf your content is not in English, you should configure that utility.\n\n## Install\n\nThis package is [ESM only][esm].\nIn Node.js (version 16+), install with [npm][]:\n\n```sh\nnpm install mdast-util-gfm-footnote\n```\n\nIn Deno with [`esm.sh`][esmsh]:\n\n```js\nimport {gfmFootnoteFromMarkdown, gfmFootnoteToMarkdown} from 'https://esm.sh/mdast-util-gfm-footnote@2'\n```\n\nIn browsers with [`esm.sh`][esmsh]:\n\n```html\n<script type=\"module\">\n  import {gfmFootnoteFromMarkdown, gfmFootnoteToMarkdown} from 'https://esm.sh/mdast-util-gfm-footnote@2?bundle'\n</script>\n```\n\n## Use\n\nSay our document `example.md` contains:\n\n```markdown\nIn the Solar System, Mercury[^mercury] and Venus[^venus] have very small tilts.\n\n[^mercury]:\n    **Mercury** is the first planet from the Sun and the smallest\n    in the Solar System.\n\n[^venus]:\n    **Venus** is the second planet from\n    the Sun.\n```\n\n…and our module `example.js` looks as follows:\n\n```js\nimport fs from 'node:fs/promises'\nimport {fromMarkdown} from 'mdast-util-from-markdown'\nimport {\n  gfmFootnoteFromMarkdown,\n  gfmFootnoteToMarkdown\n} from 'mdast-util-gfm-footnote'\nimport {toMarkdown} from 'mdast-util-to-markdown'\nimport {gfmFootnote} from 'micromark-extension-gfm-footnote'\n\nconst value = await fs.readFile('example.md', 'utf8')\n\nconst tree = fromMarkdown(value, {\n  extensions: [gfmFootnote()],\n  mdastExtensions: [gfmFootnoteFromMarkdown()]\n})\n\nconsole.log(tree)\n\nconst result = toMarkdown(tree, {\n  extensions: [gfmFootnoteToMarkdown({firstLineBlank: true})]\n})\n\nconsole.log(result)\n```\n\n…now running `node example.js` yields (positional info removed for brevity):\n\n```js\n{\n  type: 'root',\n  children: [\n    {\n      type: 'paragraph',\n      children: [\n        {type: 'text', value: 'In the Solar System, Mercury'},\n        {type: 'footnoteReference', identifier: 'mercury', label: 'mercury'},\n        {type: 'text', value: ' and Venus'},\n        {type: 'footnoteReference', identifier: 'venus', label: 'venus'},\n        {type: 'text', value: ' have very small tilts.'}\n      ]\n    },\n    {\n      type: 'footnoteDefinition',\n      identifier: 'mercury',\n      label: 'mercury',\n      children: [\n        {\n          type: 'paragraph',\n          children: [\n            {type: 'strong', children: [{type: 'text', value: 'Mercury'}]},\n            {\n              type: 'text',\n              value:\n                ' is the first planet from the Sun and the smallest\\n' +\n                'in the Solar System.'\n            }\n          ]\n        }\n      ]\n    },\n    {\n      type: 'footnoteDefinition',\n      identifier: 'venus',\n      label: 'venus',\n      children: [\n        {\n          type: 'paragraph',\n          children: [\n            {type: 'strong', children: [{type: 'text', value: 'Venus'}]},\n            {type: 'text', value: ' is the second planet from\\nthe Sun.'}\n          ]\n        }\n      ]\n    }\n  ]\n}\n```\n\n```markdown\nIn the Solar System, Mercury[^mercury] and Venus[^venus] have very small tilts.\n\n[^mercury]:\n    **Mercury** is the first planet from the Sun and the smallest\n    in the Solar System.\n\n[^venus]:\n    **Venus** is the second planet from\n    the Sun.\n```\n\n## API\n\nThis package exports the identifiers\n[`gfmFootnoteFromMarkdown`][api-gfmfootnotefrommarkdown] and\n[`gfmFootnoteToMarkdown`][api-gfmfootnotetomarkdown].\nThere is no default export.\nIt exports the type [`ToMarkdownOptions`][api-to-markdown-options].\n\n### `gfmFootnoteFromMarkdown()`\n\nCreate an extension for\n[`mdast-util-from-markdown`][mdast-util-from-markdown]\nto enable GFM footnotes in markdown.\n\n###### Returns\n\nExtension for `mdast-util-from-markdown`\n([`FromMarkdownExtension`][frommarkdownextension]).\n\n### `gfmFootnoteToMarkdown(options?)`\n\nCreate an extension for\n[`mdast-util-to-markdown`][mdast-util-to-markdown]\nto enable GFM footnotes in markdown.\n\n###### Parameters\n\n* `options` ([`ToMarkdownOptions`][api-to-markdown-options], optional)\n  — configuration\n\n###### Returns\n\nExtension for `mdast-util-to-markdown`\n([`ToMarkdownExtension`][tomarkdownextension]).\n\n### `ToMarkdownOptions`\n\nConfiguration (TypeScript type).\n\n###### Fields\n\n* `firstLineBlank` (`boolean`, default: `false`)\n  — use a blank line for the first line of footnote definitions\n\n## HTML\n\nThis utility does not handle how markdown is turned to HTML.\nThat’s done by [`mdast-util-to-hast`][mdast-util-to-hast].\nIf your content is not in English, you should configure that utility.\n\n## Syntax\n\nSee [Syntax in `micromark-extension-gfm-footnote`][syntax].\n\n## Syntax tree\n\nThe following interfaces are added to **[mdast][]** by this utility.\n\n### Nodes\n\n#### `FootnoteDefinition`\n\n```idl\ninterface FootnoteDefinition <: Parent {\n  type: 'footnoteDefinition'\n  children: [FlowContent]\n}\n\nFootnoteDefinition includes Association\n```\n\n**FootnoteDefinition** (**[Parent][dfn-parent]**) represents content relating\nto the document that is outside its flow.\n\n**FootnoteDefinition** can be used where **[flow][dfn-flow-content]** content\nis expected.\nIts content model is also **[flow][dfn-flow-content]** content.\n\n**FootnoteDefinition** includes the mixin\n**[Association][dfn-mxn-association]**.\n\n**FootnoteDefinition** should be associated with\n**[FootnoteReferences][dfn-footnote-reference]**.\n\nFor example, the following markdown:\n\n```markdown\n[^alpha]: bravo and charlie.\n```\n\nYields:\n\n```js\n{\n  type: 'footnoteDefinition',\n  identifier: 'alpha',\n  label: 'alpha',\n  children: [{\n    type: 'paragraph',\n    children: [{type: 'text', value: 'bravo and charlie.'}]\n  }]\n}\n```\n\n#### `FootnoteReference`\n\n```idl\ninterface FootnoteReference <: Node {\n  type: 'footnoteReference'\n}\n\nFootnoteReference includes Association\n```\n\n**FootnoteReference** (**[Node][dfn-node]**) represents a marker through\nassociation.\n\n**FootnoteReference** can be used where\n**[phrasing][dfn-phrasing-content]** content is expected.\nIt has no content model.\n\n**FootnoteReference** includes the mixin **[Association][dfn-mxn-association]**.\n\n**FootnoteReference** should be associated with a\n**[FootnoteDefinition][dfn-footnote-definition]**.\n\nFor example, the following markdown:\n\n```markdown\n[^alpha]\n```\n\nYields:\n\n```js\n{\n  type: 'footnoteReference',\n  identifier: 'alpha',\n  label: 'alpha'\n}\n```\n\n### Content model\n\n#### `FlowContent` (GFM footnotes)\n\n```idl\ntype FlowContentGfm = FootnoteDefinition | FlowContent\n```\n\n#### `PhrasingContent` (GFM footnotes)\n\n```idl\ntype PhrasingContentGfm = FootnoteReference | PhrasingContent\n```\n\n## Types\n\nThis package is fully typed with [TypeScript][].\nIt does not export additional types.\n\nThe `FootnoteDefinition` and `FootnoteReference` types of the mdast nodes are\nexposed from `@types/mdast`.\n\n## Compatibility\n\nProjects maintained by the unified collective are compatible with maintained\nversions of Node.js.\n\nWhen we cut a new major release, we drop support for unmaintained versions of\nNode.\nThis means we try to keep the current release line,\n`mdast-util-gfm-footnote@^2`, compatible with Node.js 16.\n\n## Related\n\n* [`remark-gfm`][remark-gfm]\n  — remark plugin to support GFM\n* [`mdast-util-gfm`][mdast-util-gfm]\n  — same but all of GFM (autolink literals, footnotes, strikethrough, tables,\n  tasklists)\n* [`micromark-extension-gfm-footnote`][micromark-extension-gfm-footnote]\n  — micromark extension to parse GFM footnotes\n\n## Contribute\n\nSee [`contributing.md`][contributing] in [`syntax-tree/.github`][health] for\nways to 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<!-- Definitions -->\n\n[api-gfmfootnotefrommarkdown]: #gfmfootnotefrommarkdown\n\n[api-gfmfootnotetomarkdown]: #gfmfootnotetomarkdownoptions\n\n[api-to-markdown-options]: #tomarkdownoptions\n\n[author]: https://wooorm.com\n\n[backers-badge]: https://opencollective.com/unified/backers/badge.svg\n\n[build]: https://github.com/syntax-tree/mdast-util-gfm-footnote/actions\n\n[build-badge]: https://github.com/syntax-tree/mdast-util-gfm-footnote/workflows/main/badge.svg\n\n[chat]: https://github.com/syntax-tree/unist/discussions\n\n[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg\n\n[cmark-gfm]: https://github.com/github/cmark-gfm\n\n[coc]: https://github.com/syntax-tree/.github/blob/main/code-of-conduct.md\n\n[collective]: https://opencollective.com/unified\n\n[contributing]: https://github.com/syntax-tree/.github/blob/main/contributing.md\n\n[coverage]: https://codecov.io/github/syntax-tree/mdast-util-gfm-footnote\n\n[coverage-badge]: https://img.shields.io/codecov/c/github/syntax-tree/mdast-util-gfm-footnote.svg\n\n[dfn-flow-content]: #flowcontent-gfm-footnotes\n\n[dfn-footnote-definition]: #footnotedefinition\n\n[dfn-footnote-reference]: #footnotereference\n\n[dfn-mxn-association]: https://github.com/syntax-tree/mdast#association\n\n[dfn-node]: https://github.com/syntax-tree/unist#node\n\n[dfn-parent]: https://github.com/syntax-tree/mdast#parent\n\n[dfn-phrasing-content]: #phrasingcontent-gfm-footnotes\n\n[downloads]: https://www.npmjs.com/package/mdast-util-gfm-footnote\n\n[downloads-badge]: https://img.shields.io/npm/dm/mdast-util-gfm-footnote.svg\n\n[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c\n\n[esmsh]: https://esm.sh\n\n[frommarkdownextension]: https://github.com/syntax-tree/mdast-util-from-markdown#extension\n\n[gfm]: https://github.github.com/gfm/\n\n[health]: https://github.com/syntax-tree/.github\n\n[license]: license\n\n[mdast]: https://github.com/syntax-tree/mdast\n\n[mdast-util-from-markdown]: https://github.com/syntax-tree/mdast-util-from-markdown\n\n[mdast-util-gfm]: https://github.com/syntax-tree/mdast-util-gfm\n\n[mdast-util-to-hast]: https://github.com/syntax-tree/mdast-util-to-hast\n\n[mdast-util-to-markdown]: https://github.com/syntax-tree/mdast-util-to-markdown\n\n[micromark]: https://github.com/micromark/micromark\n\n[micromark-extension-gfm-footnote]: https://github.com/micromark/micromark-extension-gfm-footnote\n\n[npm]: https://docs.npmjs.com/cli/install\n\n[post]: https://github.blog/changelog/2021-09-30-footnotes-now-supported-in-markdown-fields/\n\n[remark-gfm]: https://github.com/remarkjs/remark-gfm\n\n[size]: https://bundlejs.com/?q=mdast-util-gfm-footnote\n\n[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=mdast-util-gfm-footnote\n\n[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg\n\n[support]: https://github.com/syntax-tree/.github/blob/main/support.md\n\n[syntax]: https://github.com/micromark/micromark-extension-gfm-footnote#syntax\n\n[tomarkdownextension]: https://github.com/syntax-tree/mdast-util-to-markdown#options\n\n[typescript]: https://www.typescriptlang.org\n","readmeFilename":"readme.md","users":{"flumpus-dev":true}}