Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/IonicaBizau/mdy
:eyes: View markdown files in the command line with ANSI styled images.
https://github.com/IonicaBizau/mdy
hacktoberfest
Last synced: about 2 months ago
JSON representation
:eyes: View markdown files in the command line with ANSI styled images.
- Host: GitHub
- URL: https://github.com/IonicaBizau/mdy
- Owner: IonicaBizau
- License: mit
- Created: 2016-04-26T13:05:55.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-08-09T13:37:17.000Z (about 4 years ago)
- Last Synced: 2024-07-05T16:36:32.319Z (3 months ago)
- Topics: hacktoberfest
- Language: JavaScript
- Homepage:
- Size: 17.6 KB
- Stars: 20
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](#)
# `$ mdy`
[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [](https://github.com/IonicaBizau/ama) [](https://www.npmjs.com/package/mdy) [](https://www.npmjs.com/package/mdy) [](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)
> View markdown files in the command line with ANSI styled images.
[](#)
## :cloud: Installation
You can install the package globally and use it as command line tool:
```sh
# Using npm
npm install --global mdy
# Using yarn
yarn global add mdy
```
Then, run `mdy --help` and see what the CLI tool can do.
```
$ mdy --help
Usage: mdy [options]
View markdown files in the command line with ANSI styled images.
Command arguments:
The path to the markdown file.
Options:
-v, --version Displays version information.
-h, --help Displays this help.
Documentation can be found at https://github.com/IonicaBizau/mdy#readme.
```
## :clipboard: Example
Here is an example how to use this package as library. To install it locally, as library, you can do that using `npm` (or `yarn`):
```sh
# Using npm
npm install --save mdy
# Using yarn
yarn add mdy
```
```js
const cliMd = require("mdy");
console.log(cliMd(`${__dirname}/../README.md`));
```
## :question: Get Help
There are few ways to get help:
1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:
3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
## :memo: Documentation
For full API reference, see the [DOCUMENTATION.md][docs] file.
## :yum: How to contribute
Have an idea? Found a bug? See [how to contribute][contributing].
## :sparkling_heart: Support my projects
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
this takes time. You can integrate and use these projects in your applications *for free*! You can even change the source code and redistribute (even resell it).
However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:
- Starring and sharing the projects you like :rocket:
- [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
- [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
- [![Support me on Patreon][badge_patreon]][patreon]—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
- **Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6`
Thanks! :heart:
## :scroll: License
[MIT][license] © [Ionică Bizău][website]
[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg
[patreon]: https://www.patreon.com/ionicabizau
[amazon]: http://amzn.eu/hRo9sIZ
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW
[license]: http://showalicense.com/?fullname=Ionic%C4%83%20Biz%C4%83u%20%3Cbizauionica%40gmail.com%3E%20(https%3A%2F%2Fionicabizau.net)&year=2016#license-mit
[website]: https://ionicabizau.net
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md