hdg-md

hdg-md is a Markdown previewer that provides a simple method to view a file.md using the 'marked' package.

Installation

To use hdg-md, you'll need to have Node.js installed on your computer. Then, you can install the package globally using npm:

npm install -g hdg-md

Usage

To use hdg-md, simply include it in the head of your file

const render = require('hdg-md')

Then in your code use it on a markdown file as such:

render('file.md')

Dependencies

hdg-md relies on the following dependencies:

• marked

These dependencies will be installed automatically when you install hdg-md using npm.

Contributing

If you'd like to contribute to hdg-md, feel free to join the hdg-discord

Known Issues

At the moment, there are no known issues or bugs with hdg-md. However, if you encounter any issues while using the package, please submit an issue on the GitHub repository.

Documentation

There is no formal documentation or user guide for hdg-md at this time. However, you can find more information about the marked package on npm.

Examples

You can see examples of hdg-md in action by visiting the GitHub repository.

Contact

If you have any questions, feedback, or suggestions for hdg-md, please don't hesitate to get in touch with [email protected]

License

This project is licensed under the Mozilla Public License v 2.0