https://github.com/brussell98/discord-markdown

A markdown parser with the same rules as Discord
https://github.com/brussell98/discord-markdown

Last synced: 7 days ago
JSON representation

A markdown parser with the same rules as Discord

• Host: GitHub
• URL: https://github.com/brussell98/discord-markdown
• Owner: brussell98
• License: mit
• Created: 2017-11-11T20:26:04.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2024-07-29T11:03:33.000Z (3 months ago)
• Last Synced: 2024-10-26T16:55:21.283Z (10 days ago)
• Language: JavaScript
• Size: 1.72 MB
• Stars: 117
• Watchers: 5
• Forks: 41
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# discord-markdown

A markdown parser for Discord messages.

## Using

```bash

yarn add discord-markdown

npm i discord-markdown

```

For browser use, import `dist/discord-markdown.min.js`

```js

const { parser, htmlOutput, toHTML } = require('discord-markdown');

console.log(toHTML('This **is** a __test__'));

// => This is a test

```

Fenced codeblocks will include highlight.js tags and classes.

## Options

```js

const { toHTML } = require('discord-markdown');

toHTML('This **is** a __test__', options);

```

`options` is an object with the following properties (all are optional):

* `embed`: Boolean (default: false), if it should parse embed contents (rules are slightly different)

* `escapeHTML`: Boolean (default: true), if it should escape HTML

* `discordOnly`: Boolean (default: false), if it should only parse the discord-specific stuff

* `discordCallback`: Object, callbacks used for discord parsing. Each receive an object with different properties, and are expected to return an HTML escaped string

  * `user`: (`id`: Number) User mentions "@someperson"

  * `channel`: (`id`: Number) Channel mentions "#somechannel"

  * `role`: (`id`: Number) Role mentions "@somerole"

  * `everyone`: () Everyone mention "@everyone"

  * `here`: () Here mention "@here"

* `cssModuleNames`: Object, maps CSS class names to CSS module class names

### Mention and Emoji Handling

Using the `discordCallback` option you can define custom functions to handle parsing mention and emoji content. You can use these to turn IDs into names.

Example:

```js

const { toHTML } = require('discord-markdown');

toHTML('This is a mention for <@95286900801146880>', {

	discordCallback: {

		user: node => '@' + users[node.id];

	}

}); // -> This is a mention for @Brussell

```

## Customizing

It is possible to change the rules used by discord-markdown. Take a look at the code to see how to create your own modified rule set.

## Contributing

Find an inconsistency? File an issue or submit a pull request with the fix and updated test(s).