{"_id":"@daguej/markdown-it-terminal","_rev":"1-536372318ede5e47e6a5955a45f9ef45","name":"@daguej/markdown-it-terminal","dist-tags":{"latest":"0.2.0"},"versions":{"0.2.0":{"name":"@daguej/markdown-it-terminal","version":"0.2.0","description":"Plugin for markdown-it to parse and output markdown formatted for the terminal","main":"index.js","scripts":{"test":"mocha tests/test"},"repository":{"type":"git","url":"git+ssh://git@github.com/trabus/markdown-it-terminal.git"},"keywords":["markdown","markdown-it","terminal","cardinal","markdown-to-terminal"],"author":{"name":"Jake Bixby"},"license":"MIT","bugs":{"url":"https://github.com/daguej/markdown-it-terminal/issues"},"homepage":"https://github.com/daguej/markdown-it-terminal","dependencies":{"ansi-styles":"^3.0.0","cardinal":"^1.0.0","cli-table":"^0.3.1","lodash.merge":"^4.6.2","markdown-it":"^8.3.1"},"devDependencies":{"chai":"^3.5.0","mocha":"^6.2.2"},"gitHead":"5f14133b2c7afb78367ddb0e83455b78e2638cc2","_id":"@daguej/markdown-it-terminal@0.2.0","_nodeVersion":"12.16.2","_npmVersion":"6.14.4","dist":{"integrity":"sha512-R9LzCdQCwlfnNXqfYObw6N2PBWPdQjj/hSQOyo0kthD5NhtJ/7v0YkrHbUVURnq+beBxx2gdT6PIeERKDRAALw==","shasum":"224628a6124bbf9405359716d685e52143f97160","tarball":"https://registry.npmjs.org/@daguej/markdown-it-terminal/-/markdown-it-terminal-0.2.0.tgz","fileCount":8,"unpackedSize":23263,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeqOGtCRA9TVsSAnZWagAAYoYQAKAAcoCk3nFZau0UYyjc\nado8KaWuo5+R+Kgn9HOZThPuJLC4bLqn38kA5NDYGvVO6q/WRKvOabtlJPF7\nSyLNcJ9Lx9Kpnf6kvlHxUzOeehACX+jrn6pdo/+SxsSwAHSdhas3KHPdfP72\nIXH2npHMHS9CUqlL02N35r2SMplW1ioDpp52uvRj6KGw2FduNpA+fgzTPtf0\n43uIXMJA0xjnflnkZuig+x9JsQFiHL086egecSXSrjUAZdtpmn86Kg5zPjA3\n65oCs1BlCbKsrUMPLiTPMRynxfa3/yL7S5xZcx4OPIQ6RZxCAVkEQ9Yx5hBH\nuLm4rj2u/fv1HLvY0C31HPGCvjU9J/AYT8A+Kd2mtyOt2rKwK7gJZlj37YDZ\n4dWwjVsjN1mFp107nS7ks5i4XfaRPgCvbn18lC1HVVWujKh1+RaBLh8nZhIt\nZaFzLKrud0GZcV6QdWfscRsH56EVMCjcm0s1ceVn/2H2p5QoeJ/iqUcfW2Fk\nrbroTzGZgZZ4JLh50ei9QP0kxBbNFiJoouMYT1+2oosZ4s9rssVTfvc/LL7x\nEoedkURQs/UeGniLVfJpy341ej6t8sy4cYV9ilngDDz4/RCguxgUrjkbzkQI\n+lkPhegWXjoin+RlaTpKw+P45PvN5Y76KiCI/EenHsuDTYIniSlPjB9Fv06D\n0R2V\r\n=/RHy\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIFrl8c7dsA4GFy/d1I4I+jGWO7/3POBi0/FCu2mm7pkrAiAZM/i6dyNRZIPAj2EazPiQArX4aniOYPtnVjAXN6xMCQ=="}]},"maintainers":[{"name":"daguej","email":"daguej@email.uc.edu"}],"_npmUser":{"name":"daguej","email":"daguej@email.uc.edu"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/markdown-it-terminal_0.2.0_1588126125109_0.4276844155806554"},"_hasShrinkwrap":false}},"time":{"created":"2020-04-29T02:08:45.108Z","0.2.0":"2020-04-29T02:08:45.220Z","modified":"2022-04-05T02:33:31.302Z"},"maintainers":[{"name":"daguej","email":"daguej@email.uc.edu"}],"description":"Plugin for markdown-it to parse and output markdown formatted for the terminal","homepage":"https://github.com/daguej/markdown-it-terminal","keywords":["markdown","markdown-it","terminal","cardinal","markdown-to-terminal"],"repository":{"type":"git","url":"git+ssh://git@github.com/trabus/markdown-it-terminal.git"},"author":{"name":"Jake Bixby"},"bugs":{"url":"https://github.com/daguej/markdown-it-terminal/issues"},"license":"MIT","readme":"markdown-it-terminal\n===\nThis is a plugin to provide ansi terminal output for markdown-it. It is heavily inspired by [marked-terminal](https://github.com/mikaelbr/marked-terminal), a terminal renderer for the marked library.\n\n__This library is not officially supported by markdown-it.__\n\nThis forked release adds [#13](https://github.com/trabus/markdown-it-terminal/pull/13) to upstream v0.1.1.\n\n## Install\n\n`npm install markdown-it markdown-it-terminal`\n\n## Usage\n\n`markdown-it` provides a method for extending it with plugins.\n```js\nvar markdown = require('markdown-it');\nvar terminal = require('markdown-it-terminal');\n\nmarkdown.use(terminal);\n```\n\nYou can override the default options if you choose.\n```js\nvar styles   = require('ansi-styles');\nvar markdown = require('markdown-it');\nvar terminal = require('markdown-it-terminal');\n\nvar options = {\n  styleOptions: {\n    code: styles.green\n  }\n}\nmarkdown.use(terminal, options);\n// inline code now prints in green instead of the default yellow\n```\n\n## Options\n`markdown-it-terminal` takes several options, most of which are to override existing defaults.\n```js\nvar options = {\n  styleOptions:{},\n  highlight: require('cardinal').highlight,\n  unescape: true,\n  indent: '  '\n}\n```\n\n### styleOptions\nStyles are defined per token, and make use of the `ansi-styles` library, which provides a number of open and close values for ansi codes.\n\nIn the most basic implementation, you can simply provide a supported style like so:\n```js\nvar styles   = require('ansi-styles');\n\nvar options = {\n  styleOptions: {\n    code: styles.green\n  }\n}\n```\n`markdown-it-terminal` exposes a utility method to build compound styles, using an array of style names (must be supported by `ansi-styles`).\n\n```js\nvar styles   = require('ansi-styles');\nvar terminal = require('markdown-it-terminal');\n\nvar options = {\n  styleOptions: {\n    code: terminal.compoundStyle(['green','underline'])\n  }\n}\n```\n\nThe following tokens can be overridden through styleOptions:\n* code\n* blockquote\n* html\n* heading\n* firstHeading\n* hr\n* listitem\n* table\n* paragraph\n* strong\n* em\n* codespan\n* del\n* link\n* href\n\n### highlight\nHighlight function to parse code blocks. Should be a function that takes a string and outputs a formatted string.\n\n### unescape\nUnescape content, `true` by default.\n\n### indent\nIndent all content under a heading (`h1`..`h6`) using this string.  With `indent: '  '` (two spaces):\n\n| Markdown                   | Rendered                      |\n| -------------------------- | ----------------------------- |\n| <pre># Heading 1<br>## Heading 2<br>Some stuff indented twice<br>#<br>Only indented once</pre> | <pre>Heading 1<br>  Heading 2<br>    Some stuff indented twice<br><br>  Only indented once</pre> |\n\n## Highlighting\n`markdown-it-terminal` uses the [cardinal](https://github.com/thlorenz/cardinal) library \nfor code highlight support by default.\n\n## Windows Support\nBecause ansi is not supported on cmd.exe, `markdown-it-terminal` only works on Windows shells with ansi support.","readmeFilename":"README.md"}