Rxann / sparkmd

A lightweight and speedy Markdown renderer for the console

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Early Beta!

Please open an issue if you encounter any bugs.

sparkmd

A lightweight and speedy Markdowns renderer for the console

Installation

npm install sparkmd

Example Usage

import spark from "sparkmd";
spark("example.md");

Supported Markdown Syntax

Currently supported features are:


Headers up to - ###
Bold
Italic
Strikethrough
Code

Coming soon features:


Links

Contributing

Please fork the repository and submit a pull request.


About

A lightweight and speedy Markdown renderer for the console

License:GNU General Public License v3.0


Languages

Language:TypeScript 65.9%Language:JavaScript 34.1%