https://github.com/itzderock/discord-markdown-parser

A library to parse discord style markdown into an abstract syntax tree.
https://github.com/itzderock/discord-markdown-parser

discord hacktoberfest markdown parse parser

Last synced: 20 days ago
JSON representation

A library to parse discord style markdown into an abstract syntax tree.

• Host: GitHub
• URL: https://github.com/itzderock/discord-markdown-parser
• Owner: ItzDerock
• License: apache-2.0
• Created: 2022-09-17T15:58:51.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-26T17:14:09.000Z (6 months ago)
• Last Synced: 2024-10-19T23:20:18.851Z (27 days ago)
• Topics: discord, hacktoberfest, markdown, parse, parser
• Language: TypeScript
• Homepage:
• Size: 129 KB
• Stars: 26
• Watchers: 2
• Forks: 10
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# `discord-markdown-parser`

[![Discord](https://img.shields.io/discord/555474311637499955?label=discord)](https://discord.gg/rf5qN7C)

[![npm](https://img.shields.io/npm/dw/discord-markdown-parser)](http://npmjs.org/package/discord-markdown-parser)

![GitHub package.json version](https://img.shields.io/github/package-json/v/ItzDerock/discord-markdown-parser)

![GitHub Repo stars](https://img.shields.io/github/stars/ItzDerock/discord-markdown-parser?style=social)

A node.js markdown implementation based on the [simple-markdown](https://github.com/Khan/simple-markdown) library, which is the same technology [discord use](https://discord.com/blog/how-discord-renders-rich-messages-on-the-android-app).

Designed to be used for [discord-html-transcripts](https://github.com/ItzDerock/discord-html-transcripts)

`discord-markdown-parser` will parse any given string into an [AST tree](https://en.wikipedia.org/wiki/Abstract_syntax_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

-   & 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 { rules } from 'discord-markdown-parser';

// and you can add your own rules

const newRules = {

    ...rules,

    customRule: {

        ...

    } // see simple-markdown documentation for details

};

// import simpleMarkdown

import SimpleMarkdown from 'simple-markdown';

// and create the parser

const parser = SimpleMarkdown.parserFor(newRules);

```