{"_id":"@author.io/metadoc-md","_rev":"7-9af27fd6a1d3928332c8b200929bb8aa","name":"@author.io/metadoc-md","dist-tags":{"latest":"0.0.5"},"versions":{"0.0.1":{"name":"@author.io/metadoc-md","version":"0.0.1","description":"Parse markdown code within description attributes of a metadoc output file.","bin":{"metadoc-md":"cli.js"},"main":"index.js","scripts":{"test":"tap -R spec test/*.js | standard --verbose | snazzy"},"keywords":["metadoc","markdown","md","gfm"],"author":{"name":"Corey Butler"},"license":"MIT","dependencies":{"marked":"^0.5.0","mathjax-node":"^2.1.1","mermaid":"^8.0.0-rc.8","minimist-string":"^1.0.2","traverse":"^0.6.6"},"gitHead":"e083de36d0e7c756766116bd3e2f3a0403673cf7","_id":"@author.io/metadoc-md@0.0.1","_npmVersion":"6.2.0","_nodeVersion":"10.8.0","_npmUser":{"name":"cbutler","email":"corey@coreybutler.com"},"dist":{"integrity":"sha512-0N9dW5rpVTPKi87ucAvpBAlzI1kHvjB69DWI5tEEgZe/l/gcYvaMUS42KnCekIziN4QwxY648i3IjJohV+9lLA==","shasum":"0e593c0234aa220d067b9585fb7159762801a04a","tarball":"https://registry.npmjs.org/@author.io/metadoc-md/-/metadoc-md-0.0.1.tgz","fileCount":5,"unpackedSize":13250,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbhhBCCRA9TVsSAnZWagAAtfcQAJVJwr1rbyFfSQWk2eKo\nSWzaPdwXQ0BNPIvERzgl2aOMOlzzfyANpW7dDbHEHVQOwOg8NLufiqac+ZPr\nNOET96h829bmHCl0PfFlsAZU1t7pmT8tCkrlPP5jy1yarVoxS2p2EY1vEFy6\nXJ1g/yNheqSYOXA35+pLUZIS8OM1OLgdttVCcYJ6Q1BVCrrTKDT5vR2qI18x\nPjqHMCZGg5pk5AfiwqnmAthm3yhN0eDHnxm+d4zpnh3pEb9oyu5uKKoZ2hpQ\nUgEbNSL4JDEoF2tiFJFCbREqB5qntMg0Ua7ZOh7U8ErFVw6l4rwRSvkCNIGm\na6d2xfpYDFY+QkevK+5ura0128eXo7Jc0D3LUvSxVB397pAtoIikuz53Pxsw\nX8ma9Q3bUacLVcWNwDg7ZGNmweRgSGB2ORLFNExjNfEsjZaYEx3Kgb97TbgX\npXfyz1GZww/FZeKWZTAVtNeV9Pb8s6MQy63KfV2WRQv3EfjU4SXWimP2f2ZR\n+H9jNOC+6pdISW6rU5b9t1DxgyjOii3GHd2QZrtfA7FX487gMp9qL/mXxqG1\nmQrGWafW7xX4B9Uf+Ul/pDmsZHRnHgk3IqW5rF2DjtQInk8Sqqk0l0EhTqSH\naAQFiZU1U6Nvnvxypww1tu0CrsapvLKCUH9gEXhWJkDQ2A8fZNKGErEVrMu6\nfLhN\r\n=REf5\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBbJhNK7390bYbNoDqJTY5aiYkVuF+phojP1Tf3g34VRAiEApAl5vC/MeT/eEuV0ArJF28M2GwQTSDp4q4MXo/uaSFk="}]},"maintainers":[{"name":"cbutler","email":"corey@coreybutler.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/metadoc-md_0.0.1_1535512641272_0.8522654044371987"},"_hasShrinkwrap":false},"0.0.2":{"name":"@author.io/metadoc-md","version":"0.0.2","description":"Parse markdown code within description attributes of a metadoc output file.","bin":{"metadoc-md":"cli.js"},"main":"index.js","scripts":{"test":"tap -R spec test/*.js && standard --verbose | snazzy"},"keywords":["metadoc","markdown","md","gfm"],"author":{"name":"Corey Butler"},"license":"MIT","dependencies":{"@author.io/metadoc-plugin":"^1.0.3","marked":"^0.5.0","mathjax-node":"^2.1.1","mermaid":"^8.0.0-rc.8","traverse":"^0.6.6"},"devDependencies":{"snazzy":"^8.0.0","standard":"^12.0.0","tap":"^12.0.1"},"gitHead":"57fd0ccd8cb4eda11fbf96385f5201ceb6aaad6a","_id":"@author.io/metadoc-md@0.0.2","_npmVersion":"6.2.0","_nodeVersion":"10.8.0","_npmUser":{"name":"cbutler","email":"corey@coreybutler.com"},"dist":{"integrity":"sha512-hWWdMtmAE8bP9ob5unl2Lf6KlMxPNGlHCOLBAhdbA3a63Tg1C9bdhZ6+0IFiWfrOx6QiKZ5kdCu34989fsuUvA==","shasum":"f3a97ab38d0ee5efdae51411f02d5e963179d1af","tarball":"https://registry.npmjs.org/@author.io/metadoc-md/-/metadoc-md-0.0.2.tgz","fileCount":5,"unpackedSize":11437,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbh2XUCRA9TVsSAnZWagAA0/QP/19/R3TgOh1oNapKET+C\nUoa688n1cYHmu8dLqxR0+DYQAQdkcpQqzE6G3reEL4y3huFTCSixePNsoiwj\nv9nIcuMXa/3oiCVeckMQaNLULCvsq2eWaEgUaGebc1iV/TlrizsHYIvrN8CI\nFAO8sKZnQGNw5ChOUXA06aaTiqtZbgcSEDlzWug/za9ZGUGJhxOod0K3kSOa\na7v+TSqTBu6aBpKqRLkZkiKWanJf2DDwWWjfho2OFC9EjBhyNHkFTRLl+/eS\n568nXt43bsZbzKy68yO0AHCNJeUARornbAD2jOdgU3LgaPPbf1sgjsGz/Bc4\noxzWlbFCOBaTQ3/1pHl5wR2EUPssk4X4+GQsjQ7YB1d74CDYdsfv5Yvh38H3\nzAWQOAekn8iQzpmgJTcXNW5/WSvNliX+UH/oSQS9KehvYI34+FRNX6SRlP8F\nnOxIZxBnrk2mSpKH8RFNHmuRcc1lUTkynjAjMOGee5oibiRmo7HJLP+zjtLY\nwDWg/rME3ssYTEPgWr3ZVbBZJMgP1GpSsZdw5Ntke6CTGSgenXm+U2ly7arW\nq28cr1+N1dMAA8gX/swn2ju8DKeAykZSvXM1xgelDuaA+mELipOPD6uiE+8f\nYJDyxp4EjIFPG0dAbeiX4a77dThH0H98FzujZRviv7oFbAOAmvoY+bX0UePk\nolgX\r\n=0KWn\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDmzoY+STnLtuTihq1aF7qCXibcPgdmM6W5aHIqfwr/awIgS+mOltB/q9LM6L5+BjoCVw5b5Aldvg6i+E5gIRevH94="}]},"maintainers":[{"name":"cbutler","email":"corey@coreybutler.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/metadoc-md_0.0.2_1535600083854_0.8039859915924688"},"_hasShrinkwrap":false},"0.0.3":{"name":"@author.io/metadoc-md","version":"0.0.3","description":"Parse markdown code within description attributes of a metadoc output file.","bin":{"metadoc-md":"cli.js"},"main":"index.js","scripts":{"test":"tap -R spec test/*.js && standard --verbose | snazzy"},"keywords":["metadoc","markdown","md","gfm"],"author":{"name":"Corey Butler"},"license":"MIT","dependencies":{"@author.io/metadoc-plugin":"^1.0.10","marked":"^0.5.0","mathjax-node":"^2.1.1","mermaid":"^8.0.0-rc.8","traverse":"^0.6.6"},"devDependencies":{"snazzy":"^8.0.0","standard":"^12.0.1","tap":"^12.0.1"},"gitHead":"844531f8451ff0e594a9fb14d6d6637acf8a37e0","_id":"@author.io/metadoc-md@0.0.3","_npmVersion":"6.4.1","_nodeVersion":"10.11.0","_npmUser":{"name":"cbutler","email":"corey@coreybutler.com"},"dist":{"integrity":"sha512-Fii4nMAB896ahrRYhpm/kPyEMYk6NSH7mfRSk0wanOfyW80/tnrtlrV3PhTpAcUwb7eO9ZDojLbN/tqnq1gtdA==","shasum":"439c47279c8e6b5e473075f15e9fd559a2d46d1d","tarball":"https://registry.npmjs.org/@author.io/metadoc-md/-/metadoc-md-0.0.3.tgz","fileCount":5,"unpackedSize":11380,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbpubSCRA9TVsSAnZWagAA4W0QAJMmN4bx8Q1JoYwBWFsA\nlT3Z4N11ySVFQEnPku2tlfoA06yRRUKMyeiZEH9AEYkL5hF4ug2orQoT77XC\nFpYKaC4YbgaTSrpKo6OD1Nfi+Jr2Pa+fe+GUfhTzvnQdXEYhrZjdItv0boBd\nbjspW3+MHC9EyqcVOwyaGL+mJlpQxUqzaLLn1luOvWuGWiPu2iS/yxEMOMQX\nHxYRUFDY3pRdBDUvUKcFf8F8E/WwlqQb97feZO94wZPOyvh9FyeK1K66LH5u\n19g0aaY1rPK5r/dAjKX9HP5/Vb/jNNsNXlM8YSEf2HHJWjVdFA/XwQPTjxbl\nC7CnNkS640nFlYODNXwND0Wh9h69iSq+0iEpx65Iw9OR5ueRAQljaarw/4EM\nodiNKe2RLfHk7dkorlACAdfnXe342aBhRqQ+Gq+bz86nm7uvcY58Ni3SgIm/\nNdkXZw5jXbLVj5nRLr4MMOr3nzz6NVorx4lFR4RO4HDLTqZ+jM+MmxXlQiZ/\nc8LUFP44Ucpx3LQua6DS8L9bezNqRdcqfkI/M+F6FoNSDJhs7cUVEFKxTRG1\njI/4V1Ng8LNvGf7FcZFG0eps4jwjrKi+8bmpwE+9BiKfkBsu9hnCw3VvQIvz\n4bmcP6z5uc5CICCWQol7p3VmLotwHXEJ34o1lLzbgHcsy3L72X/WQIdIPZ/2\n+U98\r\n=hq6R\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIG2EkpaizJJBqvjLeEQ+rRHPYqijNrPuwRvby6g2srO1AiBckDC5Nnf+EDc1bEbnzbjpRuEGeqmbcGZs18es4WpZLA=="}]},"maintainers":[{"name":"cbutler","email":"corey@coreybutler.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/metadoc-md_0.0.3_1537664721982_0.9827951002043283"},"_hasShrinkwrap":false},"0.0.4":{"name":"@author.io/metadoc-md","version":"0.0.4","description":"Parse markdown code within description attributes of a metadoc output file.","bin":{"metadoc-md":"cli.js"},"main":"index.js","scripts":{"test":"tap -R spec test/*.js && standard --verbose | snazzy"},"keywords":["metadoc","markdown","md","gfm"],"author":{"name":"Corey Butler"},"license":"MIT","dependencies":{"@author.io/metadoc-plugin":"^1.0.11","marked":"^0.5.0","traverse":"^0.6.6"},"devDependencies":{"snazzy":"^8.0.0","standard":"^12.0.1","tap":"^12.0.1"},"gitHead":"b8699d5bbb7f539c57b2d6c336aead81e813ecb5","_id":"@author.io/metadoc-md@0.0.4","_npmVersion":"6.4.1","_nodeVersion":"10.11.0","_npmUser":{"name":"cbutler","email":"corey@coreybutler.com"},"dist":{"integrity":"sha512-M4HwFNZwjiPT2EZd9s6kbQSXqsDUpxwGLtbFBLk7Kb9wysF+phONJpPIFQg9vTo8jN005f9eKmFyMMik1M/98Q==","shasum":"83e8254c908cf1f6b7afeef0a27d589163bd4f1d","tarball":"https://registry.npmjs.org/@author.io/metadoc-md/-/metadoc-md-0.0.4.tgz","fileCount":5,"unpackedSize":11320,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcLC4iCRA9TVsSAnZWagAAh8sP/0dzg63UeJqQErkOvdfL\nM2xFxwdGRTmNcsBn6IoU/V7pkrnBYsa6Mw4HmRANaU3sycoi1r3NZJYuLJro\nhcwLZQrF4bcqAAesDkFFuoTPhJmHUgYwS/Ny4HOrHsgRW38xFJi8YOiLVC/q\nxI+TNBh9k0JvtdlnaMGpW6lBs0JlWrmrzE4u24IQrafTuQvRRG51tl0Sfw/h\nknKbOExI/bfgxt0trirMAGzQgsvbz38lEO/W8tawjrbfWpjU8q068zrG2WEW\nC14E97vufOdBrSKb42iqe5YeyLMk7DfppP7Sxe27+E79DWlfArZyy20tviY5\nHckN72zNYD4xU42/3UhULX0M3tu8owZsz4bUa56ghKuO62d1DWny6TF+Aaru\nw8wS59nYXX43BEkSQf+LYQ/S2SqPt9N6BBCsLx+Zn1oCatDID+Uptu0fm0fQ\nnkievDbM7x+4TnvJfXuzKOq1FusWzU86KQzTQ53iS+BnOCtGHa1I7niy+5V6\nhcfS0n6O65CET0Q0O7y/L74fRN9FDgLC2OJOBHDh/RyowzRTpRbnE+J3pjGG\nplXeegyZmMTdr8xH7d3kMZ+lSSPCcW2J59F5tzODYEPKXZsPSqyC5Rf5SGP5\nCXf8gcyMdPWPnS5hic5DmLfzc7WCHf+mq55fZlok33z4q2xencgtyVrE9fXW\nG6T9\r\n=iZ/D\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICHpDKy1h6lt2bPzTXWkwy0I/47CeQcUAwQ3gcF4eiUIAiAXx7/p9jaJCYUfoDWly+q0cr5Zd3eA9F55NudNiJ9cqg=="}]},"maintainers":[{"name":"cbutler","email":"corey@coreybutler.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/metadoc-md_0.0.4_1546399266163_0.5495894257422136"},"_hasShrinkwrap":false},"0.0.5":{"name":"@author.io/metadoc-md","version":"0.0.5","description":"Parse markdown code within description attributes of a metadoc output file.","bin":{"metadoc-md":"cli.js"},"main":"index.js","scripts":{"test":"tap -R spec test/*.js && standard --verbose | snazzy"},"keywords":["metadoc","markdown","md","gfm"],"author":{"name":"Corey Butler"},"license":"MIT","dependencies":{"@author.io/metadoc-plugin":"^1.0.12","marked":"^0.6.2","traverse":"^0.6.6"},"devDependencies":{"snazzy":"^8.0.0","standard":"^12.0.1","tap":"^14.2.0"},"gitHead":"c439941ceaabf8ff477a02a248f8eb20e69024e0","_id":"@author.io/metadoc-md@0.0.5","_nodeVersion":"10.11.0","_npmVersion":"6.9.0","dist":{"integrity":"sha512-sutvXRqnSzMKf/SmkKgriGv6ysik/gAliu7S4vT9eAz3/T93qMnUWsNb3/CVo9CCp2nxQcNc0BIPt1gtcV/HtA==","shasum":"84ca2564acb12f03953bf5ae82dfc3b647847f1a","tarball":"https://registry.npmjs.org/@author.io/metadoc-md/-/metadoc-md-0.0.5.tgz","fileCount":5,"unpackedSize":11001,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJc8alhCRA9TVsSAnZWagAACh0P/icRv0ELSz/8kZdCdEZx\nWTqs3XuO4Ts2Qh8Bdrb/IzoxFnYZYA4ozvCBXgglxOA/h6TtbNbcIv/vBb4r\nDaBl/N4TGFq/UHpTmeBMP0EEX1FRTPprdhCs0OdFCnUzUr0Klb1xXkqKemj1\n2PZKdjgkA7WU9FIhZx333uyDGDC05WjqVvTAzyUyNnU7/HsE9BZ/0S3eDUbw\nMA4hikAFWVgFHT0ASO7mAOQuLP2xt3BDlIvPoJP4zkOtjlo/30rLJB+1t4l6\nA3Se0hdCKXvvLznfWm8Dz7qLFE7brmNaRjvHfEygoZlLkLhifaJPi5KoaJW+\nfzx9j9z5BGrUfkrMCFrHKxj8Q29C8YsYI7d0/9QwFYLNBlr/YGuWtzQy2X8O\nO9ScrDyusZq3pMJ8hjWMG0bqgz3LREFuyEQ7whW7iuxWZa5D264C8mvh7BqY\nTLox8uRtGIKd26gF4aGZdLOF29HsEzQn8yXbOxDIgWNR1bmutrHy5moFrIUV\nv9h08XK3q/mQKvFNdXAwRcXYvSvF1bt4ctVIqLyskuEJnIlfvjE/B4//551z\n47mkxGeiv6XyH06WIu7jNkT0QtgnkZrngyowEWsYtge8zazc6sWVzklAOerA\nq9ytJT1NGypaeXfJsepcchC1b4EjZeKwYsVo39Y4Pu/oN4CpOx0ZYtdEYos+\nQPIb\r\n=dZjw\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIESzGtx22vvREZFBFqMM1DhHEeYaoplqbrJCiwkxvi8OAiBadsyqbcuYq78bxZHx4zucrZ8XBVKNLKXjhImSW5l+xw=="}]},"maintainers":[{"email":"cicd@author.io","name":"authoriocicd"},{"email":"corey@coreybutler.com","name":"cbutler"}],"_npmUser":{"name":"cbutler","email":"corey@coreybutler.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/metadoc-md_0.0.5_1559341408551_0.6991099146765478"},"_hasShrinkwrap":false}},"time":{"created":"2018-08-29T03:17:21.150Z","0.0.1":"2018-08-29T03:17:21.614Z","modified":"2022-07-25T21:05:53.071Z","0.0.2":"2018-08-30T03:34:43.970Z","0.0.3":"2018-09-23T01:05:22.130Z","0.0.4":"2019-01-02T03:21:06.329Z","0.0.5":"2019-05-31T22:23:28.680Z"},"maintainers":[{"email":"graham@grahambutler.com","name":"gbdrummer"},{"email":"corey@coreybutler.com","name":"cbutler"},{"email":"cicd@author.io","name":"authoriocicd"}],"description":"Parse markdown code within description attributes of a metadoc output file.","keywords":["metadoc","markdown","md","gfm"],"author":{"name":"Corey Butler"},"license":"MIT","readme":"# metadoc-md\n\nThis [metadoc](https://github.com/author/metadoc) post-processor will convert markdown, mermaid, or MathJax snippets within a metadoc's description attributes into HTML.\n\n_Metadoc output before metadoc-md:_\n\n\n\n_Metadoc output after metadoc-md:_\n\n\n\n## Usage\n\nThis post-processor can be run standalone or as a part of a metadoc build process.\n\nTo run as a standalone CLI application, the utility must be installed globally:\n\n`npm install -g @author.io/metadoc-md`\n\nIt can then be used from the command line:\n\n```sh\nmetadoc-md --source /path/to/metadoc/api.json\n```\n\nAlternatively, it metadoc-md can be a part of a series of metadoc post-processors. In this scenario, the module should be saved as part of the `devDependencies`:\n\n`npm install @author.io/metadoc-md --save-dev`\n\nIt can then be applied as a piped command to the metadoc generation process:\n\n```sh\nmetadoc --source ./src --output ./docs --warnskippedevents --warnnocode --ignore ./work/in/progress | metadoc-md\n```\n\n## Additional Flags\n\n_Common Flags:_\n\n- `--output` Specify a custom output file (relative or absolute path).\n\n_Boolean Flags:_\n\nEach boolean flag (except `--output`) can receive a `true`/`false` value to enable/disable a feature. For example, to disable GFM, use `--gfm false`. If no value is supplied, it is assumed to be `true`. This means `--gfm` is the same as `--gfm true`.\n\n- `--pedantic` Conform to the original markdown.pl as much as possible. Don't fix original markdown bugs or behavior. Turns off and overrides gfm.\n- `--gfm` Apply [Github Flavored Markdown](https://github.github.com/gfm/). Enabled by default\n- `--tables` When using `gfm`, use [GFM Tables extension](https://github.github.com/gfm/#tables-extension-). Enabled by default.\n- `--breaks` \tIf true, use GFM hard and soft line breaks. Requires `gfm` be true.\n- `--smartlists` If true, use smarter list behavior than those found in markdown.pl.\n- `--smartypants` If true, use \"smart\" typographic punctuation for things like quotes and dashes.\n- `--xhtml` If true, emit self-closing HTML tags for void elements (
, ![]()
, etc.) with a \"/\" as required by XHTML.\n- `--svg` Renders mermaid SVG files. See mermaid support secction below.\n\nThese features are all implemented by passing configuration values into [marked configuration options](https://marked.js.org/#/USING_ADVANCED.md#options).\n\n## Mermaid Support\n\n\n\n[Mermaid](https://github.com/knsv/mermaid) generates graphical SVG diagrams from text. It follows a markdown-like approach. metadoc-md identifies mermaid text and converts it to an HTML-friendly format.\n\nFor example:\n\n_Metadoc output before metadoc-md:_\n\n````\n```mermaid\ngraph LR\na-->b;\nb-->c;\n```\n````\n\n_Metadoc output after metadoc-md:_\n\n```html\n\n graph LR\n a-->b;\n b-->c;\n
\n```\n\nAs shown above, metadoc-md identifies mermaid code and generates an HTML container for it with an automatic ID. However; it does not generate the SVG graphic. Mermaid provides a [browser library](https://www.jsdelivr.com/package/npm/mermaid) for this, which can parse the HTML and replace it with an SVG graphic. See the [usage instructions](https://mermaidjs.github.io/mermaidAPI.html)) for detail.\n\n### Recognized Mermaid Types\n\n- sequenceDiagram\n- classDiagram\n- graph (flowcharts)\n- gitGraph\n- gantt\n\n## MathJAX Support\n\n\n\n[MathJax](http://mathjax.org/) will generate equation displays from text. Metadoc-md identifies these equations using a markdown-like approach.\n\nFor example:\n\n_Before metadoc-md:_\n\n````\n```math-tex\nx = {-b \\pm \\sqrt{b^2-4ac} \\over 2a}\n```\n````\n\n_After metadoc-md:_\n\n```html\n\n x = {-b \\pm \\sqrt{b^2-4ac} \\over 2a}\n
\n```\n\nAs shown above, metadoc-md identifies MathJax code and generates the HTML container for it. Notice the language is `math-tex`, indicating the equation content is LaTeX format. `math-inlinetex`, `math-asciimath`, and `math-mathml` are also supported by MathJax. However; metadoc-md does not generate any graphics. The [MathJax Getting Started Guide](https://www.mathjax.org/#gettingstarted) provides instructions for generating the graphics in the browser.\n","readmeFilename":"README.md"}