View markdown files in the command line with ANSI styled images.
You can install the package globally and use it as command line tool:
# Using npmnpm install --global mdy# Using yarnyarn global add mdy
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.
Here is an example how to use this package as library. To install it locally, as library, you can do that using
# Using npmnpm install --save mdy# Using yarnyarn add mdy
const cliMd = ;console;
❓ 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. 🐛
For direct and quick help, you can use Codementor. 🚀
For full API reference, see the DOCUMENTATION.md file.
😋 How to contribute
Have an idea? Found a bug? See how to contribute.
💖 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 🚀
Bitcoin—You can send me bitcoins at this address (or scanning the code below):