Mdy NPM | npm.io

`$ mdy`

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:

# 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 <path> [options]

View markdown files in the command line with ANSI styled images.

Command arguments:
  <path>  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):

# Using npm
npm install --save mdy

# Using yarn
yarn add mdy

const cliMd = require("mdy");

console.log(cliMd(`${__dirname}/../README.md`));

:question: Get Help

There are few ways to get help:

Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
For bug reports and feature requests, open issues. :bug:
For direct and quick help, you can use Codementor. :rocket:

:memo: Documentation

For full API reference, see the DOCUMENTATION.md file.

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

: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:
—I love books! I will remember you after years if you buy me one. :grin: :book:
—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
—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