{"id":13715067,"url":"https://github.com/ephraimduncan/termd","last_synced_at":"2025-04-30T22:23:08.216Z","repository":{"id":46946295,"uuid":"318793848","full_name":"ephraimduncan/termd","owner":"ephraimduncan","description":"Render markdown in the terminal","archived":false,"fork":false,"pushed_at":"2022-12-09T11:30:04.000Z","size":574,"stargazers_count":68,"open_issues_count":4,"forks_count":6,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-19T01:19:22.714Z","etag":null,"topics":["cli","javascript","markdown","termd","terminal","typescript"],"latest_commit_sha":null,"homepage":"","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/ephraimduncan.png","metadata":{"files":{"readme":"readme.md","changelog":null,"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":"2020-12-05T13:21:04.000Z","updated_at":"2025-02-21T00:52:43.000Z","dependencies_parsed_at":"2023-01-25T13:15:42.258Z","dependency_job_id":null,"html_url":"https://github.com/ephraimduncan/termd","commit_stats":null,"previous_names":["ephraimduncan/termd","dephraiim/termd"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ephraimduncan%2Ftermd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ephraimduncan%2Ftermd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ephraimduncan%2Ftermd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ephraimduncan%2Ftermd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ephraimduncan","download_url":"https://codeload.github.com/ephraimduncan/termd/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251790303,"owners_count":21644204,"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":["cli","javascript","markdown","termd","terminal","typescript"],"created_at":"2024-08-03T00:00:53.556Z","updated_at":"2025-04-30T22:23:08.196Z","avatar_url":"https://github.com/ephraimduncan.png","language":"TypeScript","funding_links":[],"categories":["Tools","cli"],"sub_categories":["Miscellaneous"],"readme":"# termd\n\n\u003e Render Markdown in the Terminal\n\n[![NPM Version][npm-image]][npm-url]\n\nPreview and render markdown files in the terminal with color syntax highlighting. Also render markdown from a given `url` or from a GitHub repository and an npm package.\n\n## Screenshots\n\n![Image1](./assets/screenshot1.png)\n\n![Image2](./assets/screenshot.png)\n\n## Installation\n\n```sh\nnpm install -g termd\n\n# Using `npx`\nnpx termd [options]\n```\n\n## Usage example\n\n### Basic usage\n\nTo render a markdown file in the terminal, use the `termd` command with the file name or relative path to the markdown file.\n\n```sh\ntermd \u003cfilename\u003e\n\n# Example\ntermd readme.md\n\n....\n```\n\n#### Commands\n\n```\n--string, -s    Use a string with markdown syntax\n--url, -u       Render markdown from url in the terminal\n--npm, -n       Render npm package readme in the terminal\n--github, -g    Render github repository readme in the terminal\n```\n\n#### Examples\n\n##### Render a markdown syntax in the terminal\n\n```sh\ntermd --string=\"## Heading 2\"\ntermd -s ## Heading 2\nHeading 2\n```\n\n##### Render a markdown from a given url\n\n```sh\ntermd --url=\"https://some.url/with/markdown/file\"\ntermd -u https://some.url/with/markdown/file\n...\n```\n\n##### Render readme of an npm package\n\n```sh\ntermd --npm=\"termd\" # Package name\ntermd -n termd\n...\n```\n\n##### Render readme of a github repository\n\n```\ntermd --github=\"dephraiim/termd\" # Repo Owner / Repo Name\ntermd -g dephraiim/termd\n...\n```\n\n## Development setup\n\nTo begin developing, do this.\n\n```sh\ngit clone https://github.com/dephraiim/termd.git\ncd termd\nnpm install\n```\n\n## Contributing\n\n1. [Fork](https://github.com/dephraiim/termd/fork) it\n2. Create your feature branch (`git checkout -b feature/fooBar`)\n3. Commit your changes (`git commit -am 'Add some fooBar'`)\n4. Push to the branch (`git push origin feature/fooBar`)\n5. Create a new Pull Request\n\n## License\n\nMIT © [Ephraim Atta-Duncan](https://twitter.com/dephraiim)\n\n\u003c!-- Markdown link \u0026 img dfn's --\u003e\n\n[npm-image]: https://img.shields.io/npm/v/termd.svg\n[npm-url]: https://npmjs.org/package/termd\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fephraimduncan%2Ftermd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fephraimduncan%2Ftermd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fephraimduncan%2Ftermd/lists"}