discord-markdown-parser

!GitHub package.json version
!GitHub Repo stars

A node.js markdown implementation based on the simple-markdown library, which is the same technology discord use.

Designed to be used for discord-html-transcripts

discord-markdown-parser will parse any given string into an AST tree and supports:

- links
- block quotes
- inline quotes
- code blocks
- inline code
- italics (em)
- spoilers
- timestamps
- bold
- strikethrough
- underline
- channel mentions
- user mentions
- role mentions
- @everyone
- @here
- emojis
- slash command mentions
- guild navigation mentions
- & more

Usage

``js
import { parse } from 'discord-markdown-parser';
// or const { parse } = require('discord-markdown-parser');

// input is a string
const input = 'test markdown with cool stuff';

// specify what type of markdown this is
// this can be 'normal' or 'extended' (default = normal)
// extended should be used if the input is from a webhook message or embed description.
const type = 'normal';

// will return an AST tree
const parsed = parse(input, type);
`

Extending

`js
// you can import the default rules using
import { SimpleMarkdown, rules } from 'discord-markdown-parser';

// and you can add your own rules
const newRules = {
...rules,
customRule: {
...
} // see simple-markdown documentation for details
};

// and create the parser
const parser = SimpleMarkdown.parserFor(newRules);
``