{"id":13910920,"url":"https://github.com/piotrmurach/tty-markdown-cli","last_synced_at":"2025-06-12T13:09:26.763Z","repository":{"id":59158176,"uuid":"287959768","full_name":"piotrmurach/tty-markdown-cli","owner":"piotrmurach","description":"CLI tool for displaying nicely formatted Markdown documents in the terminal","archived":false,"fork":false,"pushed_at":"2023-06-30T22:58:59.000Z","size":40,"stargazers_count":6,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-22T14:08:55.011Z","etag":null,"topics":["cli","markdown","markdown-cli","markdown-viewer","rubygem"],"latest_commit_sha":null,"homepage":"","language":"Ruby","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/piotrmurach.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"piotrmurach"}},"created_at":"2020-08-16T14:29:00.000Z","updated_at":"2024-07-10T17:59:44.000Z","dependencies_parsed_at":"2024-11-25T20:31:42.326Z","dependency_job_id":"71133cb2-11b7-4504-9d1a-b0136727a831","html_url":"https://github.com/piotrmurach/tty-markdown-cli","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/piotrmurach/tty-markdown-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piotrmurach%2Ftty-markdown-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piotrmurach%2Ftty-markdown-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piotrmurach%2Ftty-markdown-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piotrmurach%2Ftty-markdown-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/piotrmurach","download_url":"https://codeload.github.com/piotrmurach/tty-markdown-cli/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piotrmurach%2Ftty-markdown-cli/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259470951,"owners_count":22862999,"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","markdown","markdown-cli","markdown-viewer","rubygem"],"created_at":"2024-08-07T00:01:50.338Z","updated_at":"2025-06-12T13:09:26.730Z","avatar_url":"https://github.com/piotrmurach.png","language":"Ruby","funding_links":["https://github.com/sponsors/piotrmurach"],"categories":["Ruby"],"sub_categories":[],"readme":"# TTY::Markdown CLI\n\n[![Gem Version](https://badge.fury.io/rb/tty-markdown-cli.svg)][gem]\n[![Actions CI](https://github.com/piotrmurach/tty-markdown-cli/workflows/CI/badge.svg?branch=master)][gh_actions_ci]\n[![Build status](https://ci.appveyor.com/api/projects/status/3i2mn2nh9hq1cag2?svg=true)][appveyor]\n\n[gem]: https://badge.fury.io/rb/tty-markdown-cli\n[gh_actions_ci]: https://github.com/piotrmurach/tty-markdown-cli/actions?query=workflow%3ACI\n[appveyor]: https://ci.appveyor.com/project/piotrmurach/tty-markdown-cli\n\n\u003e CLI tool for displaying Markdown documents in a nicely formatted terminal output.\n\n**TTY::Markdown CLI** provides cli for [TTY::Markdown](https://github.com/piotrmurach/tty-markdown)\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem \"tty-markdown-cli\"\n```\n\nAnd then execute:\n\n    $ bundle install\n\nOr install it yourself as:\n\n    $ gem install tty-markdown-cli\n\n## Usage\n\nRun `tty-markdown` with `-h` or `--help` options to print help information:\n\n```bash\n$ tty-markdown --help\n```\n\nTo preview a Markdown document like this `README.md`:\n\n```bash\n$ tty-markdown README.md\n```\n\nTo pipe a Markdown document like this `README.md` file:\n\n```bash\n$ cat README.md | tty-markdown\n```\n\nBy default `UTF-8` symbols are used to display terminal output but you can fallback on more widely supported `ASCII` set with `-a/--ascii`:\n\n```bash\n$ tty-markdown -a README.md\n$ tty-markdown --ascii README.md\n```\n\nFurther, you can control the amount of indentation with `-i/--indent` option. By default 2 spaces are used but you can, for example, remove any indentation:\n\n```bash\n$ tty-markdown -i 0 README.md\n$ tty-markdown --indent 0 README.md\n```\n\nYou can also use `-w/--width` option to specify the maximum output width. By default the output will span the full terminal width. To make output wrap around `80` characters do:\n\n```bash\n$ tty-markdown -w 80 README.md\n$ tty-markdown --width 80 README.md\n```\n\nTo control output coloring, use `-c/--color` option with `always`, `never` or `auto`:\n\n```bash\n$ tty-markdown -c always README\n$ tty-markdown --color always README\n```\n\n## Development\n\nAfter checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.\n\nTo install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/piotrmurach/tty-markdown-cli. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/piotrmurach/tty-markdown-cli/blob/master/CODE_OF_CONDUCT.md).\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n\n## Code of Conduct\n\nEveryone interacting in the `tty-markdown-cli` project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/piotrmurach/tty-markdown-cli/blob/master/CODE_OF_CONDUCT.md).\n\n## Copyright\n\nCopyright (c) 2020 Piotr Murach (piotrmurach.com). See LICENSE for further details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpiotrmurach%2Ftty-markdown-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpiotrmurach%2Ftty-markdown-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpiotrmurach%2Ftty-markdown-cli/lists"}