{"repo":"piotrmurach/tty-markdown","free":true,"listed":false,"github":"https://github.com/piotrmurach/tty-markdown","clone":"git clone https://github.com/piotrmurach/tty-markdown.git","description":"Convert a markdown document or text into a terminal friendly output.","language":"Ruby","stars":327,"topics":["tty","rubygem","cli","terminal","console","console-application","markdown"],"license":"MIT","category":"cli-tools","readme_excerpt":"TTY::Markdown [ ][gem] [ ][gh actions ci] [ ][appveyor] [ ][qlty] [ ][coverage] [gem]: https://badge.fury.io/rb/tty-markdown [gh actions ci]: https://github.com/piotrmurach/tty-markdown/actions/workflows/ci.yml [appveyor]: https://ci.appveyor.com/project/piotrmurach/tty-markdown [qlty]: https://qlty.sh/gh/piotrmurach/projects/tty-markdown [coverage]: https://coveralls.io/github/piotrmurach/tty-markdown Convert a Markdown document or text into a terminal friendly output. TTY::Markdown provides a Markdown processing component for the TTY Toolkit. Installation Add this line to your application's Gemfile: And then execute: Or install it yourself as: Contents 1. Usage 1.1 Header 1.2 List 1.3 Definition List 1.4 Link 1.5 Blockquote 1.6 Code and Syntax Highlighting 1.7 Table 1.8 Horizontal Rule 1.9 Footnotes 2. Options 2.1 :mode 2.2 :theme 2.3 :width 2.4 :symbols 2.5 :indent 2.6 :color 3. Command line tool 1. Usage Using parse method, you can transform a Markdown string into a terminal formatted content: The parse file allows you to transform a Markdown document into a terminal formatted output: 1.1 Header Parsing the following Markdown headers: The terminal output looks like this: 1.2 List Both numbered and unordered lists are supported. Given a Markdown: The parsed output looks like this: 1.3 Definition List Given a definition list: The parsed output looks like this: 1.4 Link A Markdown link: The link text will be rendered with the link next to it: 1.5 Blockquote Given a Markdown ","default_branch":null,"files":null,"tree":[],"storefront":"/r/piotrmurach","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/piotrmurach/tty-markdown/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}