Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/piotrmurach/tty-markdown-cli

CLI tool for displaying nicely formatted Markdown documents in the terminal
https://github.com/piotrmurach/tty-markdown-cli

cli markdown markdown-cli markdown-viewer rubygem

Last synced: 17 days ago
JSON representation

CLI tool for displaying nicely formatted Markdown documents in the terminal

Host: GitHub
URL: https://github.com/piotrmurach/tty-markdown-cli
Owner: piotrmurach
License: mit
Created: 2020-08-16T14:29:00.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2023-06-30T22:58:59.000Z (over 1 year ago)
Last Synced: 2024-11-09T12:19:39.742Z (about 1 month ago)
Topics: cli, markdown, markdown-cli, markdown-viewer, rubygem
Language: Ruby
Homepage:
Size: 39.1 KB
Stars: 6
Watchers: 3
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

project-awesome - piotrmurach/tty-markdown-cli - CLI tool for displaying nicely formatted Markdown documents in the terminal (Ruby)

README

# TTY::Markdown CLI

[![Gem Version](https://badge.fury.io/rb/tty-markdown-cli.svg)][gem]
[![Actions CI](https://github.com/piotrmurach/tty-markdown-cli/workflows/CI/badge.svg?branch=master)][gh_actions_ci]
[![Build status](https://ci.appveyor.com/api/projects/status/3i2mn2nh9hq1cag2?svg=true)][appveyor]

[gem]: https://badge.fury.io/rb/tty-markdown-cli
[gh_actions_ci]: https://github.com/piotrmurach/tty-markdown-cli/actions?query=workflow%3ACI
[appveyor]: https://ci.appveyor.com/project/piotrmurach/tty-markdown-cli

> CLI tool for displaying Markdown documents in a nicely formatted terminal output.

**TTY::Markdown CLI** provides cli for [TTY::Markdown](https://github.com/piotrmurach/tty-markdown)

## Installation

Add this line to your application's Gemfile:

```ruby
gem "tty-markdown-cli"
```

And then execute:

$ bundle install

Or install it yourself as:

$ gem install tty-markdown-cli

## Usage

Run `tty-markdown` with `-h` or `--help` options to print help information:

```bash
$ tty-markdown --help
```

To preview a Markdown document like this `README.md`:

```bash
$ tty-markdown README.md
```

To pipe a Markdown document like this `README.md` file:

```bash
$ cat README.md | tty-markdown
```

By default `UTF-8` symbols are used to display terminal output but you can fallback on more widely supported `ASCII` set with `-a/--ascii`:

```bash
$ tty-markdown -a README.md
$ tty-markdown --ascii README.md
```

Further, 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:

```bash
$ tty-markdown -i 0 README.md
$ tty-markdown --indent 0 README.md
```

You 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:

```bash
$ tty-markdown -w 80 README.md
$ tty-markdown --width 80 README.md
```

To control output coloring, use `-c/--color` option with `always`, `never` or `auto`:

```bash
$ tty-markdown -c always README
$ tty-markdown --color always README
```

## Development

After 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.

To 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).

## Contributing

Bug 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).

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone 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).