1.1.2 • Published 5 years ago
markdown-next v1.1.2
markdown-next
markdown-next parser
Below is the list of what is supported:
- strong
- em
- p
- headers(h1, h2, h3, h4, h5, h6)
- ul
- ol
- a
- code
- blockquote(nesting is allowed)
- table
- img
Note: This project is currently beta. Any API will be changed without notice.
Install
Clone this repo and execute npm run install
.
Basic Usage
const markdown = require("markdown-next")
parse(s: string): string
Returns parsed html string.
This is mostly shorthand of new Parser({type: asHTML}).parse
.
parse(string)
Parser({export: ExportType})
It takes ExportType
object and make new parser.
Currently, there are two options: asHTML
and asAST
which creates HTML and AST respectively
const markdown = require("markdown-next")
const parser = new markdown.Parser({
export: markdown.asHTML
})
parser.parse(string)
Test and Development
Run npm test
command for testing. Under test
contains unit tests.
Contribution
Any suggestion or PR is welcome.
LICENSE
MIT