{"_id":"@aigne/marked-terminal","_rev":"3-9bd9d7ec6cf1ec60aeb1bff185bcf084","name":"@aigne/marked-terminal","dist-tags":{"latest":"7.3.2"},"versions":{"7.3.1":{"name":"@aigne/marked-terminal","version":"7.3.1","keywords":["marked","render","terminal","markdown","markdown-to-terminal"],"author":{"name":"Mikael Brevik"},"license":"MIT","_id":"@aigne/marked-terminal@7.3.1","maintainers":[{"name":"li-yechao","email":"liyechao@yechao.xyz"},{"name":"wangshijun","email":"shijun@arcblock.io"}],"homepage":"https://github.com/mikaelbr/marked-terminal","bugs":{"url":"https://github.com/mikaelbr/marked-terminal/issues"},"dist":{"shasum":"aa87b7fa3b7448f16b92782fb73c28e46319c468","tarball":"https://registry.npmjs.org/@aigne/marked-terminal/-/marked-terminal-7.3.1.tgz","fileCount":5,"integrity":"sha512-Rb7WSk+1k1zggBnArFLXEpmNnMvlj3JU6HKPmMRDbaVZRGu9X6LmN7W6JK7JNZsIi3dhBPxA/IfTx8Jhg+ckyA==","signatures":[{"sig":"MEYCIQCM+6ZXpYJu48X+Yg4I5xGMW2OPN+DbR3G+4JKUCXs2ZAIhAIID3o1UxI7fC6lC+TKT0MctLKu/IDwcVRzmNvJKTg3O","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":1958754},"main":"./index.cjs","type":"module","browser":"./index.js","engines":{"node":">=16.0.0"},"exports":{"node":{"import":"./index.js","require":"./index.cjs"},"default":"./index.js"},"gitHead":"7d2fe43d66f12508db06bad0f3212318e67ac1ac","scripts":{"test":"cross-env FORCE_HYPERLINK=0 mocha tests/*.js --reporter spec","build":"rollup -c","prepack":"npm run build"},"_npmUser":{"name":"li-yechao","email":"liyechao@yechao.xyz"},"repository":{"url":"git+https://github.com/mikaelbr/marked-terminal.git","type":"git"},"_npmVersion":"10.9.2","description":"A custom render for marked to output to the Terminal","directories":{"example":"example"},"_nodeVersion":"23.11.0","dependencies":{"chalk":"^5.4.1","ansi-regex":"^6.1.0","cli-table3":"^0.6.5","node-emoji":"^2.2.0","ansi-escapes":"^7.0.0","cli-highlight":"^2.1.11","supports-hyperlinks":"^3.1.0"},"_hasShrinkwrap":false,"devDependencies":{"mocha":"^11.0.1","marked":"^15.0.0","rollup":"^4.29.1","cross-env":"^7.0.3","@rollup/plugin-commonjs":"^28.0.2","@rollup/plugin-node-resolve":"^16.0.0"},"peerDependencies":{"marked":">=1 <16"},"_npmOperationalInternal":{"tmp":"tmp/marked-terminal_7.3.1_1745328806948_0.7637030314006725","host":"s3://npm-registry-packages-npm-production"}},"7.3.2":{"name":"@aigne/marked-terminal","version":"7.3.2","keywords":["marked","render","terminal","markdown","markdown-to-terminal"],"author":{"name":"Mikael Brevik"},"license":"MIT","_id":"@aigne/marked-terminal@7.3.2","maintainers":[{"name":"li-yechao","email":"liyechao@yechao.xyz"},{"name":"wangshijun","email":"shijun@arcblock.io"}],"homepage":"https://github.com/mikaelbr/marked-terminal","bugs":{"url":"https://github.com/mikaelbr/marked-terminal/issues"},"dist":{"shasum":"7927a293ea3e59b271a7bc5ccead1739435fe2ee","tarball":"https://registry.npmjs.org/@aigne/marked-terminal/-/marked-terminal-7.3.2.tgz","fileCount":5,"integrity":"sha512-iaBdHAyHRSldQxESw/3YAuul/6NHX4anoKxo4MSFaSktZlYW6GPDbSjhUEl7cN4BJDcJIBBrIFYTOGC4BgZx7A==","signatures":[{"sig":"MEQCIA4bghS8QkzLpGEsLzFypeH2XF1lhx7AHGWnG4zhbJhcAiBiAYk6Zl4GvRD4gsfwtqTaeip6gDOfME9OnZwSzPW5tA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":1958754},"main":"./index.cjs","type":"module","browser":"./index.js","engines":{"node":">=16.0.0"},"exports":{"node":{"import":"./index.js","require":"./index.cjs"},"default":"./index.js"},"gitHead":"eb417fa29628e65bb781f92cbc559a0363bacc64","scripts":{"test":"cross-env FORCE_HYPERLINK=0 mocha tests/*.js --reporter spec","build":"rollup -c","prepack":"npm run build"},"_npmUser":{"name":"li-yechao","actor":{"name":"li-yechao","type":"user","email":"liyechao@yechao.xyz"},"email":"liyechao@yechao.xyz"},"repository":{"url":"git+https://github.com/mikaelbr/marked-terminal.git","type":"git"},"_npmVersion":"11.4.2","description":"A custom render for marked to output to the Terminal","directories":{"example":"example"},"_nodeVersion":"24.3.0","dependencies":{"chalk":"^5.4.1","ansi-regex":"^6.1.0","cli-table3":"^0.6.5","node-emoji":"^2.2.0","ansi-escapes":"^7.0.0","cli-highlight":"^2.1.11","supports-hyperlinks":"^3.1.0"},"_hasShrinkwrap":false,"devDependencies":{"mocha":"^11.0.1","marked":"^16.0.0","rollup":"^4.29.1","cross-env":"^7.0.3","@rollup/plugin-commonjs":"^28.0.2","@rollup/plugin-node-resolve":"^16.0.0"},"peerDependencies":{"marked":">=1 <17"},"_npmOperationalInternal":{"tmp":"tmp/marked-terminal_7.3.2_1752145683787_0.2142327917775484","host":"s3://npm-registry-packages-npm-production"}}},"time":{"created":"2025-04-22T13:33:26.867Z","modified":"2026-01-21T06:21:21.234Z","7.3.1":"2025-04-22T13:33:27.241Z","7.3.2":"2025-07-10T11:08:04.029Z"},"bugs":{"url":"https://github.com/mikaelbr/marked-terminal/issues"},"author":{"name":"Mikael Brevik"},"license":"MIT","homepage":"https://github.com/mikaelbr/marked-terminal","keywords":["marked","render","terminal","markdown","markdown-to-terminal"],"repository":{"url":"git+https://github.com/mikaelbr/marked-terminal.git","type":"git"},"description":"A custom render for marked to output to the Terminal","maintainers":[{"email":"liyechao@yechao.xyz","name":"li-yechao"},{"email":"shijun@arcblock.io","name":"wangshijun"},{"email":"rob@arcblock.io","name":"mave99a"}],"readme":"# marked-terminal\n\n> Custom Renderer for [marked](https://github.com/chjj/marked)\n> allowing for printing Markdown to the Terminal. Supports pretty tables, syntax\n> highlighting for javascript, and overriding all colors and styles.\n\nCould for instance be used to print usage information.\n\n[![build](https://github.com/mikaelbr/marked-terminal/actions/workflows/ci.yml/badge.svg)](https://github.com/mikaelbr/marked-terminal/actions/workflows/ci.yml) [![npm marked-terminal](https://img.shields.io/npm/v/marked-terminal.svg)](https://www.npmjs.com/package/marked-terminal)\n\n## Install\n\n```sh\nnpm install marked marked-terminal\n```\n\n## Example\n\n```javascript\nimport { marked } from 'marked';\nimport { markedTerminal } from 'marked-terminal';\n\nmarked.use(markedTerminal([options][, highlightOptions]));\n\nmarked.parse('# Hello \\n This is **markdown** printed in the `terminal`');\n```\n\n### Using older versions\n\n```javascript\nconst marked = require('marked');\nconst TerminalRenderer = require('marked-terminal');\n\nmarked.setOptions({\n  // Define custom renderer\n  renderer: new TerminalRenderer()\n});\n\n// Show the parsed data\nconsole.log(\n  marked('# Hello \\n This is **markdown** printed in the `terminal`')\n);\n```\n\nThis will produce the following:\n\n![Screenshot of marked-terminal](./screenshot.png)\n\n### Syntax Highlighting\n\nAlso have support for syntax highlighting using [cli-highlight](https://github.com/felixfbecker/cli-highlight).\nYou can override highlighting defaults by passing in settings as the second argument for TerminalRenderer.\n\nHaving the following markdown input:\n\n<pre>\n```js\nvar foo = function(bar) {\n  console.log(bar);\n};\nfoo('Hello');\n```\n</pre>\n\n...we will convert it into terminal format:\n\n```javascript\n// Show the parsed data\nconsole.log(marked(exampleSource));\n```\n\nThis will produce the following:\n\n![Screenshot of marked-terminal](./screenshot2.png)\n\n## API\n\nConstructur: `new TerminalRenderer([options][, highlightOptions])`\n\n### `options`\n\nOptional\nUsed to override default styling.\n\nDefault values are:\n\n```javascript\nvar defaultOptions = {\n  // Colors\n  code: chalk.yellow,\n  blockquote: chalk.gray.italic,\n  html: chalk.gray,\n  heading: chalk.green.bold,\n  firstHeading: chalk.magenta.underline.bold,\n  hr: chalk.reset,\n  listitem: chalk.reset,\n  table: chalk.reset,\n  paragraph: chalk.reset,\n  strong: chalk.bold,\n  em: chalk.italic,\n  codespan: chalk.yellow,\n  del: chalk.dim.gray.strikethrough,\n  link: chalk.blue,\n  href: chalk.blue.underline,\n\n  // Formats the bulletpoints and numbers for lists\n  list: function (body, ordered) {/* ... */},\n\n  // Reflow and print-out width\n  width: 80, // only applicable when reflow is true\n  reflowText: false,\n\n  // Should it prefix headers?\n  showSectionPrefix: true,\n\n  // Whether or not to undo marked escaping\n  // of enitities (\" -> &quot; etc)\n  unescape: true,\n\n  // Whether or not to show emojis\n  emoji: true,\n\n  // Options passed to cli-table3\n  tableOptions: {},\n\n  // The size of tabs in number of spaces or as tab characters\n  tab: 3 // examples: 4, 2, \\t, \\t\\t\n\n  image: function (href, title, text) {} // function for overriding the default image handling.\n\n  // Boolean, force enable or disable hyper link, default is `undefined`\n  // If undefined, it will dynamically determine whether the current environment supports hyperlink\n  forceHyperLink: undefined\n};\n```\n\n#### Example of overriding defaults\n\n```javascript\nmarked.setOptions({\n  renderer: new TerminalRenderer({\n    codespan: chalk.underline.magenta\n  })\n});\n```\n\n### `highlightOptions`\n\nOptions passed into [cli-highlight](https://github.com/felixfbecker/cli-highlight). See readme there to see what options to pass.\n\nSee [more examples](./example/)\n\n## Related\n\n- [ink-markdown](https://github.com/cameronhunter/ink-markdown) - Markdown component for Ink\n","readmeFilename":"README.md"}