https://github.com/dvinciguerra/mdcat

mdcat is a simple markdown terminal viewer
https://github.com/dvinciguerra/mdcat

developer-tools gem markdown markdown-viewer ruby rubygem tool

Last synced: about 1 year ago
JSON representation

mdcat is a simple markdown terminal viewer

• Host: GitHub
• URL: https://github.com/dvinciguerra/mdcat
• Owner: dvinciguerra
• License: mit
• Created: 2023-12-04T01:45:27.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-01-18T23:24:09.000Z (over 2 years ago)
• Last Synced: 2025-03-29T12:04:34.914Z (about 1 year ago)
• Topics: developer-tools, gem, markdown, markdown-viewer, ruby, rubygem, tool
• Language: Ruby
• Homepage:
• Size: 16.6 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# mdcat

[![Gem Version](https://badge.fury.io/rb/mdcat.svg)](https://badge.fury.io/rb/mdcat)

[![Build Status](https://travis-ci.org/dvinciguerra/mdcat.svg?branch=master)](https://travis-ci.org/dvinciguerra/mdcat)

[![Maintainability](https://api.codeclimate.com/v1/badges/cf154e97f0e6c10614b4/maintainability)](https://codeclimate.com/github/dvinciguerra/mdcat/maintainability)

[![Test Coverage](https://api.codeclimate.com/v1/badges/cf154e97f0e6c10614b4/test_coverage)](https://codeclimate.com/github/dvinciguerra/mdcat/test_coverage)

`mdcat` is a command line tool write in Ruby to display markdown files in the terminal.

## Installation

The recommended way to install `mdcat` is via RubyGems:

    $ gem install mdcat

## Usage

### Displaying a file

    $ mdcat README.md

### For help

    $ mdcat help

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/dvinciguerra/mdcat.

## License

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

## Author

[Daniel Vinciguerra](https://github.com/dvinciguerra)