{"id":13715053,"url":"https://github.com/BubuAnabelas/markcat","last_synced_at":"2025-05-07T03:31:12.757Z","repository":{"id":28400804,"uuid":"118087159","full_name":"BubuAnabelas/markcat","owner":"BubuAnabelas","description":":eyeglasses: Markdown files terminal viewer.","archived":false,"fork":false,"pushed_at":"2023-01-03T18:29:47.000Z","size":1528,"stargazers_count":43,"open_issues_count":18,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-25T23:36:18.729Z","etag":null,"topics":["cli","javascript","markdown","nodejs","syntax-highlighting","terminal"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/BubuAnabelas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":".github/code-of-conduct.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-01-19T06:35:33.000Z","updated_at":"2025-04-12T10:53:55.000Z","dependencies_parsed_at":"2022-07-27T14:19:57.690Z","dependency_job_id":null,"html_url":"https://github.com/BubuAnabelas/markcat","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BubuAnabelas%2Fmarkcat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BubuAnabelas%2Fmarkcat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BubuAnabelas%2Fmarkcat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BubuAnabelas%2Fmarkcat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BubuAnabelas","download_url":"https://codeload.github.com/BubuAnabelas/markcat/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252806425,"owners_count":21807201,"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","nodejs","syntax-highlighting","terminal"],"created_at":"2024-08-03T00:00:53.387Z","updated_at":"2025-05-07T03:31:10.574Z","avatar_url":"https://github.com/BubuAnabelas.png","language":"JavaScript","funding_links":[],"categories":["Tools"],"sub_categories":["Miscellaneous"],"readme":"\u003cp align=\"center\"\u003e\n\t\u003cimg src=\"https://i.imgur.com/Kp0FVMr.png\" width=\"250\" alt=\"markcat\" /\u003e\n\t\u003cbr /\u003e\n\t\u003ca href=\"https://www.npmjs.org/package/markcat\"\u003e\u003cimg src=\"https://img.shields.io/npm/v/markcat.svg\" alt=\"NPM Badge\"\u003e\u003c/a\u003e\n\t\u003ca href=\"https://travis-ci.org/BubuAnabelas/markcat\"\u003e\u003cimg src=\"https://img.shields.io/travis/BubuAnabelas/markcat.svg\" alt=\"Travis Badge\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n# markcat\n\n\u003e Markdown files terminal viewer.\n\n_Based on [marked-terminal](https://github.com/mikaelbr/marked-terminal)_\n\n- **Code highlight** right out of the box.\n- Based on the popular [**marked**](https://github.com/chjj/marked) package.\n- **Github Flavored Markdown** support.\n- Renders your emojis :tada:.\n\n## Table of Contents\n\n- [Install](#install)\n- [Usage](#usage)\n- [Example](#example)\n- [License](#license)\n\n## Install\n\nMake sure you have Node.js version 8 or higher installed\n\n```sh\n$ npm install -g markcat\n```\n\n## Usage\n\n```\n$ markcat [filename]\n\nView Markdown files in the terminal\n\nOptions:\n  --version            Show version number\n  --help               Show help\n  --no-gfm             Disable GitHub Flavored Markdown\n  --no-tables          Disable GFM tables. This option requires the gfm option\n                       to be true\n  --no-breaks          Disable GFM line breaks. This option requires the gfm\n                       option to be true\n  -p, --pedantic       Conform to original's markdown.pl as much as possible.\n                       Don't fix any of the original markdown bugs or poor\n                       behavior\n  -s, --sanitize       Sanitize the output. Ignore any HTML that has been input\n\n  -S, --no-smartlists  Use smarter list behavior than the original markdown\n\n  --smartypants        Use \"smart\" typographic punctuation for things like\n                       quotes and dashes\n```\n\n## Example\n\n[![asciicast](https://asciinema.org/a/xR59kF01pnzoKLpJ3OVbfyMlM.png)](https://asciinema.org/a/xR59kF01pnzoKLpJ3OVbfyMlM)\n\n## License\n\n[MIT License](https://oss.ninja/mit/bubuanabelas) © Joaquín Serna\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBubuAnabelas%2Fmarkcat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FBubuAnabelas%2Fmarkcat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBubuAnabelas%2Fmarkcat/lists"}