{"id":23426930,"url":"https://github.com/ziv/marked-terminal-renderer","last_synced_at":"2025-04-12T19:08:21.656Z","repository":{"id":36976933,"uuid":"376261784","full_name":"ziv/marked-terminal-renderer","owner":"ziv","description":null,"archived":false,"fork":false,"pushed_at":"2023-01-16T04:07:47.000Z","size":2303,"stargazers_count":4,"open_issues_count":14,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-12T19:08:05.928Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ziv.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-06-12T10:28:24.000Z","updated_at":"2023-08-18T11:30:49.000Z","dependencies_parsed_at":"2023-01-17T11:01:58.697Z","dependency_job_id":null,"html_url":"https://github.com/ziv/marked-terminal-renderer","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":"markedjs/marked-extension-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ziv%2Fmarked-terminal-renderer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ziv%2Fmarked-terminal-renderer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ziv%2Fmarked-terminal-renderer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ziv%2Fmarked-terminal-renderer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ziv","download_url":"https://codeload.github.com/ziv/marked-terminal-renderer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248618276,"owners_count":21134200,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-23T06:14:47.280Z","updated_at":"2025-04-12T19:08:21.626Z","avatar_url":"https://github.com/ziv.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# marked-terminal-renderer\n\nTerminal renderer [marked](https://github.com/markedjs/marked) extension.\n\n[![CI](https://github.com/ziv/marked-terminal-renderer/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/ziv/marked-terminal-renderer/actions/workflows/main.yml)\n[![CodeQL](https://github.com/ziv/marked-terminal-renderer/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/ziv/marked-terminal-renderer/actions/workflows/codeql-analysis.yml)\n\n\n## Install\n```shell\nnpm i marked-terminal-renderer\n```\n\n## Usage\n### Typescript\n```typescript\nimport terminalRenderer from 'marked-terminal-renderer';\nimport * as marked from 'marked';\nimport { readFileSync } from 'fs';\n\nmarked.use(terminalRenderer());\nconst src = readFileSync(__dirname + 'example.md').toString();\nconsole.log(marked(src));\n\n```\n\n### ESM\n```javascript\nimport terminalRenderer from 'marked-terminal-renderer';\nimport marked from 'marked';\nimport { readFileSync } from 'fs';\n\nmarked.use(terminalRenderer());\n// there is no __dirname in ESM (this is not a node environment)\nconst src = readFileSync(new URL('example.md', import.meta.url)).toString();\nconsole.log(marked(src));\n```\n\n### Examples\n```shell\nnode examples/example.mjs\n```\nOutput:\n\n\u003cimg src=\"examples/example.png\" alt=\"output\" width=\"400\"\u003e\n\n## Options\nTBW\n\n## Features\n* Colors - thanks to [chalk](https://github.com/chalk/chalk)\n* Tables - thanks to [cli-table3](https://github.com/cli-table/cli-table3)\n* Wrapping - thanks to [word-wrap](https://github.com/jonschlinkert/word-wrap)\n* Code Highlighting - thanks to [cli-highlight](https://github.com/felixfbecker/cli-highlight)\n* Emoji - thanks to [node-emoji](https://github.com/omnidan/node-emoji)\n\n\n[![downloads](https://badgen.net/npm/dt/marked-terminal-renderer)](https://www.npmjs.com/package/marked-terminal-renderer)\n[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)\n\n:)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fziv%2Fmarked-terminal-renderer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fziv%2Fmarked-terminal-renderer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fziv%2Fmarked-terminal-renderer/lists"}