{"_id":"markdown-it-front-matter","_rev":"18-b8e9f5cc217018943be025e028fe2e4d","name":"markdown-it-front-matter","time":{"modified":"2024-04-04T04:27:52.958Z","created":"2016-05-07T05:43:46.219Z","0.1.0":"2016-05-07T05:43:46.219Z","0.1.1":"2016-05-07T16:10:13.187Z","0.1.2":"2016-05-07T19:15:16.243Z","0.2.1":"2020-02-06T07:16:01.061Z","0.2.2":"2020-10-12T06:13:11.104Z","0.2.3":"2020-10-12T11:16:36.592Z","0.2.4":"2024-04-04T04:27:52.788Z"},"maintainers":[{"name":"craigdmckenna","email":"contactcraigmckenna@gmail.com"},{"name":"parksb","email":"parkgds@gmail.com"}],"dist-tags":{"latest":"0.2.4"},"description":"Plugin to process front matter container for markdown-it markdown parser","readme":"# markdown-it-front-matter\n \n[![npm](https://badge.fury.io/js/markdown-it-front-matter.svg)](https://badge.fury.io/js/markdown-it-front-matter)\n[![master-ci](https://github.com/ParkSB/markdown-it-front-matter/workflows/master-ci/badge.svg)](https://github.com/ParkSB/markdown-it-front-matter/actions?query=workflow%3Amaster-ci)\n\n> Plugin for processing front matter for markdown-it markdown parser.\n\n## Install\n\n```sh\n$ npm install markdown-it-front-matter --save\n```\n\n## Valid Front Matter\n\nEssentially, valid front matter is a fenced block:\n\n* Indicated by **three** or **more** dashes: `---`\n* Opening and closing fences must be the same number of *dash* characters\n* Opening fence must begin on the first line of the markdown string/file\n* Opening fence must not be indented\n\n```yaml\n---\nvalid-front-matter: true\n---\n```\n\n> The example above uses YAML but YAML is not required\n\n> (bring your own front matter parser)\n\n\n## Example\n\n* Front Matter is not rendered.\n* Any markup inside the block is passed to the **required** callback function.\n\n```javascript\nconst md = require('markdown-it')()\n  .use(require('markdown-it-front-matter'), function(fm) {\n    console.log(fm)\n  });\n\nlet result = md.render('---\\ntitle: This is the Title\\n---\\n# Heading\\n----\\nsome text');\n\n// > title: This is the Title\n```\n\n## References / Thanks\n\nCode heavily borrowed from [markdown-it-container](https://github.com/markdown-it/markdown-it-container)\n\n* Alex Kocharin [github/rlidwka](https://github.com/rlidwka)\n* Vitaly Puzrin [github/puzrin](https://github.com/puzrin)\n\n## License\n\n_markdown-it-front-matter_ is distributed under the MIT License - see the [LICENSE](LICENSE) file for details.\n","versions":{"0.1.1":{"name":"markdown-it-front-matter","version":"0.1.1","description":"Plugin to process front matter container for markdown-it markdown parser","repository":{"type":"git","url":"git://github.com/craigdmckenna/markdown-it-front-matter.git"},"main":"index.js","keywords":["markdown-it-plugin","markdown-it","markdown","front-matter","front matter","frontmatter","meta","meta data","meta-data","metadata"],"author":{"name":"Craig McKenna"},"license":"MIT","devDependencies":{"markdown-it":"6.0.1"},"gitHead":"f3cdf64bf02d74ecfc3e844cee7363fe3fd55ea6","bugs":{"url":"https://github.com/craigdmckenna/markdown-it-front-matter/issues"},"homepage":"https://github.com/craigdmckenna/markdown-it-front-matter#readme","_id":"markdown-it-front-matter@0.1.1","scripts":{},"_shasum":"bfcd7e59c24798f78720efbb17c15771fc92842b","_from":".","_npmVersion":"2.15.0","_nodeVersion":"4.4.2","_npmUser":{"name":"craigdmckenna","email":"contactcraigmckenna@gmail.com"},"dist":{"shasum":"bfcd7e59c24798f78720efbb17c15771fc92842b","tarball":"https://registry.npmjs.org/markdown-it-front-matter/-/markdown-it-front-matter-0.1.1.tgz","integrity":"sha512-zWTK07idxo7WtaSkx87u5WssL26KMQiDTIP+SSLIVLrhgThMsC2ESFAXHSqwBeGDVihjIyWsMvaflIFs1Ewp2w==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIG0VfmjdIcx01qgHwW04nPBonPOs6w3xuyIqPrS8caWKAiEA53x4kCaPlPIJyaslplAJ1AI41fjdqsk5XuI8M/M1sIw="}]},"maintainers":[{"name":"craigdmckenna","email":"contactcraigmckenna@gmail.com"}],"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/markdown-it-front-matter-0.1.1.tgz_1462637412759_0.0627271574921906"},"directories":{}},"0.1.2":{"name":"markdown-it-front-matter","version":"0.1.2","description":"Plugin to process front matter container for markdown-it markdown parser","repository":{"type":"git","url":"git://github.com/craigdmckenna/markdown-it-front-matter.git"},"main":"index.js","keywords":["markdown-it-plugin","markdown-it","markdown","front-matter","front matter","frontmatter","meta","meta data","meta-data","metadata"],"author":{"name":"Craig McKenna"},"license":"MIT","devDependencies":{"markdown-it":"6.0.1"},"gitHead":"7c125b2c0013887ff5337e8b628c03d34436e7ba","bugs":{"url":"https://github.com/craigdmckenna/markdown-it-front-matter/issues"},"homepage":"https://github.com/craigdmckenna/markdown-it-front-matter#readme","_id":"markdown-it-front-matter@0.1.2","scripts":{},"_shasum":"e50bf56e77e6a4f5ac4ffa894d4d45ccd9896b20","_from":".","_npmVersion":"2.15.0","_nodeVersion":"4.4.2","_npmUser":{"name":"craigdmckenna","email":"contactcraigmckenna@gmail.com"},"dist":{"shasum":"e50bf56e77e6a4f5ac4ffa894d4d45ccd9896b20","tarball":"https://registry.npmjs.org/markdown-it-front-matter/-/markdown-it-front-matter-0.1.2.tgz","integrity":"sha512-Fw90dxwgvjPL/SiI9AIkPlWpvm7708wifgFnvjWs1nB4lD1AU+HOXehxmrD4pJ1anwkMN24QROceA4RpLUd9zA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIF15XvUx01nWCufplRIzzGqCim5xOYlQIvEOWVqdu8oJAiBok1nrzLctEADYBuCZRm68pUoNgkuTrROR19fXSzjB0Q=="}]},"maintainers":[{"name":"craigdmckenna","email":"contactcraigmckenna@gmail.com"}],"_npmOperationalInternal":{"host":"packages-16-east.internal.npmjs.com","tmp":"tmp/markdown-it-front-matter-0.1.2.tgz_1462648513953_0.3364104537758976"},"directories":{}},"0.2.1":{"name":"markdown-it-front-matter","version":"0.2.1","description":"Plugin to process front matter container for markdown-it markdown parser","repository":{"type":"git","url":"git://github.com/craigdmckenna/markdown-it-front-matter.git"},"main":"index.js","keywords":["markdown-it-plugin","markdown-it","markdown","front-matter","front matter","frontmatter","meta","meta data","meta-data","metadata"],"author":{"name":"Craig McKenna"},"license":"MIT","devDependencies":{"markdown-it":"^10.0.0","mocha":"^7.0.1"},"scripts":{"test":"mocha test"},"gitHead":"c71b5b9f767f4b43a27722d13f046c421f4dfa92","bugs":{"url":"https://github.com/craigdmckenna/markdown-it-front-matter/issues"},"homepage":"https://github.com/craigdmckenna/markdown-it-front-matter#readme","_id":"markdown-it-front-matter@0.2.1","_nodeVersion":"12.14.1","_npmVersion":"6.13.4","dist":{"integrity":"sha512-ydUIqlKfDscRpRUTRcA3maeeUKn3Cl5EaKZSA+I/f0KOGCBurW7e+bbz59sxqkC3FA9Q2S2+t4mpkH9T0BCM6A==","shasum":"dca49a827bb3cebb0528452c1d87dff276eb28dc","tarball":"https://registry.npmjs.org/markdown-it-front-matter/-/markdown-it-front-matter-0.2.1.tgz","fileCount":5,"unpackedSize":8919,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeO70xCRA9TVsSAnZWagAAlLkQAKL1sinScn0YjLGSYyll\nd0hBCvon+gPoe/nbJtdWbdzM6Jdu+C9KhkkFIe6zJmRWPe/4mTfi15LCBpOx\nTCcYaTnIfAmz0r1GXNPByZddjDqWoianYMj8H1eJIjlwm0peJbUaiIrjqsvN\n25uVvn5a3/ze4uIPNb3A5rr7x5ogP6rZSu8qfbYLxZQsQGszXD7T8SPrxse3\nkcKJRoc6JH/iEVD6QNgScXjBLNjA1SS2ddAdr3VfMTl2ffXUr8SMqmNc8uek\nDcvqXTRYkZxd6gvyoqhfPEwHXE437YnG06sK9nkS8mtAXPe/P89OKjmZA6d1\nYKYmZq+WBjE/o+qfLVfeamf48S5852ig0qfDb/TxKuatXQ9oo9HDuv8YVeS/\n2r4ZRe4D6gvdKr4bqcnOX/CReXHouBY3dt1ralEQqWTedF05jgt3m5Ytxvyi\n6gW4codr3qFy71hlpckEuW5jXH9MzcxeZUiEeVBQsWCaNhMwc47/9a5reWJO\nTWgA7F46H1RKyVcqBGw6TfxbsC1IXMeETc8H2nu1T5/Uo/ssgvH5uWb9CdqP\nbLld4Yb4D0kwPcoh7viYxpXrv+zXw5EaXD46clKslwjUxm2e4lPxvrFlCgwX\nhG1oF+psuxHac3Fbk54qVeLu3sblzqn/L6HLbyWoQVTK9KHf91dUGpwvDPii\nJAwz\r\n=vgnd\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIESlHOgjhBCmm3Xlwr8wyFwKtkMgDqUwk3tcHRQUMhZDAiEA3aX4wjyflKqzpaTN92Rci4+p+8xrF9ZQkmWMb6q0bCk="}]},"maintainers":[{"email":"contactcraigmckenna@gmail.com","name":"craigdmckenna"},{"email":"tjy970721@gmail.com","name":"troy-tae"}],"_npmUser":{"name":"troy-tae","email":"tjy970721@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/markdown-it-front-matter_0.2.1_1580973360961_0.4960758341808891"},"_hasShrinkwrap":false},"0.2.2":{"name":"markdown-it-front-matter","version":"0.2.2","description":"Plugin to process front matter container for markdown-it markdown parser","repository":{"type":"git","url":"git://github.com/ParkSB/markdown-it-front-matter.git"},"main":"index.js","types":"index.d.ts","keywords":["markdown-it-plugin","markdown-it","markdown","front-matter","front matter","frontmatter","meta","meta data","meta-data","metadata"],"author":{"name":"ParkSB"},"license":"MIT","devDependencies":{"markdown-it":"^10.0.0","@types/markdown-it":"^10.0.0","mocha":"^7.0.1"},"scripts":{"test":"mocha test"},"gitHead":"d3cddd1831e533f6653255956f901bd18cf2ba89","bugs":{"url":"https://github.com/ParkSB/markdown-it-front-matter/issues"},"homepage":"https://github.com/ParkSB/markdown-it-front-matter#readme","_id":"markdown-it-front-matter@0.2.2","_nodeVersion":"10.18.1","_npmVersion":"6.13.4","dist":{"integrity":"sha512-xd5z9XIPend74zectRolWmW/WOwi0lusOiflwocbftoDXhmah+S8jK+fuHys51ESyQ0Ss3ANt0IFe5XhlYPdUw==","shasum":"b23c3aebe31f6d79c8d8a3b9739e43b51b2da742","tarball":"https://registry.npmjs.org/markdown-it-front-matter/-/markdown-it-front-matter-0.2.2.tgz","fileCount":7,"unpackedSize":10103,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfg/P3CRA9TVsSAnZWagAAwkcQAKSrFBGd4/0uxfJRQOOQ\nA2LAB6PWwcxF8LhkFmyAJmHM2DdvGUT6d3R/MfckGv4FnQbTso+p8YzAq+gJ\nGkvE3Fjs/B9/eh/Lx/mhcxw/Zrz7refUQgXXTbeuWOWGyy20bdw3OJOUvdfb\nqDxKapCXMcwAMjZS+2+2bDucb6cjK719EVwZ2YDOMZ6zLoaan2Qj/IGmjcIZ\nbn/DCHLzg11ooORMW/WSyu4LLeQOI1JtvDXudAOvzifKCBIvMpkhua+7EjD9\nExwdV8K7Oz3+/MNynPhQtBvv+6hjRZxL7L+f6hVIo4DMRhLD3kpPFmo59vwY\nv3KqFaXMWH/q7TdSkqWi48k7rbKB89GOMJ7HkIIAYcKfxgDzej76+VWvkKkz\nI0xkxYM3uKX/VfPOPb9dbsbktFRcub67fM+v2HWkaK6MykZVVmU9kPQt/zoH\nIts/uHmkuSWsA2swx3GNhZrw+M9K9JuWROX3BPLwpXo0tFYyhbqAQVuY0Oc5\n0JZ0Ju9l6BgUnn6PidPF2kMoBNPvkUBpqOq1tdFhRwBRMm5zc5oC2rFdqkxP\n98znxlH9e0klRtmxv2OKJv6MhDmn50w7bozEaKWQnAdomIS0Yoz+gk5jA/Pm\nKW4E7Oz9jz06jDIIZppFfikCkGfrBIWDQsNigqjDdkkrrdwULMF3FQ+uyJ3y\nyNSp\r\n=qirc\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCP/x0e1Up89fpEvTS1U7atTJLKEe/whO0dPsExQXsDIgIgHv8z9uopp6ZNzzk6j0q/LqIpVKpVUmCH9kDmz2f57Mk="}]},"maintainers":[{"name":"craigdmckenna","email":"contactcraigmckenna@gmail.com"},{"name":"parksb","email":"parkgds@gmail.com"}],"_npmUser":{"name":"parksb","email":"parkgds@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/markdown-it-front-matter_0.2.2_1602483190947_0.2965152587195343"},"_hasShrinkwrap":false},"0.2.3":{"name":"markdown-it-front-matter","version":"0.2.3","description":"Plugin to process front matter container for markdown-it markdown parser","repository":{"type":"git","url":"git://github.com/ParkSB/markdown-it-front-matter.git"},"main":"index.js","types":"index.d.ts","keywords":["markdown-it-plugin","markdown-it","markdown","front-matter","front matter","frontmatter","meta","meta data","meta-data","metadata"],"author":{"name":"ParkSB"},"license":"MIT","devDependencies":{"markdown-it":"^10.0.0","@types/markdown-it":"^10.0.0","mocha":"^7.0.1"},"scripts":{"test":"mocha test"},"gitHead":"6f75729e10cf4745061a7adf903b078f3ac16fe8","bugs":{"url":"https://github.com/ParkSB/markdown-it-front-matter/issues"},"homepage":"https://github.com/ParkSB/markdown-it-front-matter#readme","_id":"markdown-it-front-matter@0.2.3","_nodeVersion":"10.18.1","_npmVersion":"6.13.4","dist":{"integrity":"sha512-s9+rcClLmZsZc3YL8Awjg/YO/VdphlE20LJ9Bx5a8RAFLI5a1vq6Mll8kOzG6w/wy8yhFLBupaa6Mfd60GATkA==","shasum":"d6fa0f4b362e02086dd4ce8219fadf3f4c9cfa37","tarball":"https://registry.npmjs.org/markdown-it-front-matter/-/markdown-it-front-matter-0.2.3.tgz","fileCount":7,"unpackedSize":10161,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfhDsUCRA9TVsSAnZWagAAIHoP/jfidD9rYSNrPUUW1I0Q\nHn5CXDUgUqiuLXIim6zxLDpLRmkEopmij2p9ijnKCWzh885+51Bz8+wG4Gyq\n1HfbDgaWtlRPrLBR51EpXv2+1H0hRPLLOOaek2C65sic3cIjF2O40VlaDT9q\ng0/c9a7C+OuWlHL37GcriPz7w6LRpB4eOuFFyftXhDtj/5rolzzulYYjO5YD\nTqoX4q/vnHWIoNoxlGdqM+SRFgWaMGbSAuPd2xxFcxTcrzynkhB3KqE/xnAj\nEXMN5gvoXk9W49+GKmm9qPrMF3KcWS5vX+INAwvtgkStoTo7+PNb3bPZJEFt\nAoEjpsF9hxIPpSTWbZc6svGhQPXld20UTC3gdgQmJJbP6FCAKdQ1Shx7336K\n2CrC7LJLC/hRi3QARnCYIW8LSy4oInxP/3f+5lIOjQdmb52W3anUwC5l178h\nIm1tEcr4qULc70zH/v6ntX03vm2ftXL+kMM6YY3zjqefZ+0ixEBq1mbBmGKB\n2iXExLy6jMUsO9Y2I3Lan1TyEMwQEdWIFBL2VaBfujh53GlPBcmX6RyiQfL9\nI0IkllJGkMyFzZfolvd5Ku7VZpHQzHtPKX1wrxtJOAQvn4ObX+BDnjR5/uAm\ngA8pH48ZtBZP8mQ7ZXjgFsteLUMgbz8tNgOibqajX5zjkhWbv6gqaiO/GrRR\n/ET5\r\n=klM0\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCil5bzxC4fus0qKDz4Ly1ISt18Jl+qgD42rXtvxQsykwIhAMsoPr0MI0ns0VRrv+743jMRsxhTN2npEJVvTLPjUFAy"}]},"maintainers":[{"name":"craigdmckenna","email":"contactcraigmckenna@gmail.com"},{"name":"parksb","email":"parkgds@gmail.com"}],"_npmUser":{"name":"parksb","email":"parkgds@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/markdown-it-front-matter_0.2.3_1602501396443_0.8175499613354604"},"_hasShrinkwrap":false},"0.2.4":{"name":"markdown-it-front-matter","version":"0.2.4","description":"Plugin to process front matter container for markdown-it markdown parser","repository":{"type":"git","url":"git://github.com/ParkSB/markdown-it-front-matter.git"},"main":"index.js","types":"index.d.ts","keywords":["markdown-it-plugin","markdown-it","markdown","front-matter","front matter","frontmatter","meta","meta data","meta-data","metadata"],"author":{"name":"ParkSB"},"license":"MIT","devDependencies":{"markdown-it":"^10.0.0","@types/markdown-it":"^10.0.0","mocha":"^7.0.1"},"scripts":{"test":"mocha test"},"gitHead":"a7f5e178f2f8f907e89cc0881d799243a0e98809","bugs":{"url":"https://github.com/ParkSB/markdown-it-front-matter/issues"},"homepage":"https://github.com/ParkSB/markdown-it-front-matter#readme","_id":"markdown-it-front-matter@0.2.4","_nodeVersion":"18.7.0","_npmVersion":"9.2.0","dist":{"integrity":"sha512-25GUs0yjS2hLl8zAemVndeEzThB1p42yxuDEKbd4JlL3jiz+jsm6e56Ya8B0VREOkNxLYB4TTwaoPJ3ElMmW+w==","shasum":"cf29bc8222149b53575699357b1ece697bf39507","tarball":"https://registry.npmjs.org/markdown-it-front-matter/-/markdown-it-front-matter-0.2.4.tgz","fileCount":7,"unpackedSize":10890,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCMafyF5lGMAEYhh7G9cAalaGvSz4QG6y/d3P0gZwoD3AIgMNGhqzi/urQTi5qDZkYdzpVTX0FPcb2gmjiT3ThQOEI="}]},"_npmUser":{"name":"parksb","email":"parkgds@gmail.com"},"directories":{},"maintainers":[{"name":"craigdmckenna","email":"contactcraigmckenna@gmail.com"},{"name":"parksb","email":"parkgds@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/markdown-it-front-matter_0.2.4_1712204872642_0.16925979073367392"},"_hasShrinkwrap":false}},"homepage":"https://github.com/ParkSB/markdown-it-front-matter#readme","keywords":["markdown-it-plugin","markdown-it","markdown","front-matter","front matter","frontmatter","meta","meta data","meta-data","metadata"],"repository":{"type":"git","url":"git://github.com/ParkSB/markdown-it-front-matter.git"},"author":{"name":"ParkSB"},"bugs":{"url":"https://github.com/ParkSB/markdown-it-front-matter/issues"},"license":"MIT","readmeFilename":"README.md","users":{"craigdmckenna":true}}