Discord Markdown

A lightweight and easy-to-use library for formatting text with Discord markdown syntax

📦 Installation

npm install @dtim/discord-markdown

🚀 Quick Start

const dm = require('@dtim/discord-markdown');

// Simple formatting
message.channel.send(dm.bold('Hello World!'));
message.channel.send(dm.italics('Hello World!'));
message.channel.send(dm.code('const x = 5;'));

📚 API Reference

Basic Formatting

| Function | Description | Example Output | |----------|-------------|----------------| | bold(text) | Makes text bold | **text** | | italics(text) | Makes text italic | *text* | | boldItalics(text) | Makes text bold and italic | ***text*** | | underline(text) | Makes text underlined | __text__ | | strikethrough(text) | Makes text ~~strikethrough~~ | ~~text~~ |

Combined Formatting

| Function | Description | Example Output | |----------|-------------|----------------| | underlineItalics(text) | Underlined and italic | __*text*__ | | underlineBold(text) | Underlined and bold | __**text**__ | | underlineBoldItalics(text) | Underlined, bold and italic | __***text***__ |

Code Formatting

| Function | Description | Example Output | |----------|-------------|----------------| | code(text) | Inline code | `text` | | multiCode(text) | Code block | ```text``` |

💡 Usage Examples

Discord.js Bot Example

const Discord = require('discord.js');
const client = new Discord.Client();
const dm = require('@dtim/discord-markdown');

client.on('message', message => {
    if (message.content === '!format') {
        message.channel.send(dm.bold('This is bold!'));
        message.channel.send(dm.italics('This is italic!'));
        message.channel.send(dm.code('console.log("Hello");'));
        message.channel.send(dm.multiCode('function example() {\n    return true;\n}'));
    }
});

Combining Multiple Formats

const dm = require('@dtim/discord-markdown');

// You can combine functions
const text = dm.bold(dm.italics('Nested formatting'));
// Result: ***text***

// Or use combined functions
const text2 = dm.underlineBoldItalics('All formats');
// Result: __***text***__

Using Numbers

The library accepts both strings and numbers:

const dm = require('@dtim/discord-markdown');

dm.bold(123);        // Works! Returns "**123**"
dm.italics(42);      // Works! Returns "*42*"
dm.code(3.14);       // Works! Returns "`3.14`"

Error Handling

The library includes built-in validation for unsupported types:

const dm = require('@dtim/discord-markdown');

try {
    dm.bold({}); // Will throw TypeError
} catch (error) {
    console.error('Expected string or number');
}

📝 License

MIT © dtim

🔗 Links

• NPM Package
• GitHub Repository
• Report Issues