Skip to main content

MD2Slack - Markdown to Slack Converter

GitHub license
Build Status PyPI version
Python

MD2Slack is a Python package that converts Markdown into Slack-compatible formatting.
Easily transform Markdown syntax into a format that works seamlessly in Slack messages, preserving formatting like bold, italics, headers, lists, tables, and code blocks.


Features

  • Converts standard Markdown syntax to Slack-formatted text
  • Supports headers, lists, blockquotes, code blocks, and tables
  • Handles inline styles (bold, italics, strikethrough, and links)
  • Preserves Slack-specific mentions (@user, #channel)
  • Lightweight and efficient

Installation

You can install MD2Slack via pip:

pip install md2slack

Usage

Basic Example

Convert Markdown text into Slack-formatted output:

from md2slack import SlackMarkdown

parser = SlackMarkdown()
slack_text = parser("## Hello *world*")
print(slack_text)  # Outputs: *Hello _world_*

Development & Contribution

I welcome contributions! Follow these steps to contribute:

  1. Fork the repository
  2. Clone your fork locally
    git clone https://github.com/MayzTex/md2slack.git
    cd md2slack
    
  3. Create a new branch
    git checkout -b feature-branch
    
  4. Make changes & commit
    git add .
    git commit -m "Added new feature"
    
  5. Push & open a Pull Request
    git push origin feature-branch
    

Running Tests

To run tests locally:

pytest

License

MD2Slack is licensed under the MIT License. See the LICENSE file for details.


Support & Feedback

If you find this project useful, consider starring it on GitHub.
For issues or feature requests, please open an issue.

Release files for md2Slack 0.1.3.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for md2Slack 0.1.3.2
File Size Uploaded
md2slack-0.1.3.2.tar.gz 10.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for md2Slack 0.1.3.2
File Interpreter ABI Platform
md2slack-0.1.3.2-py3-none-any.whl Python 3 none any Details

Total release size: 20.0 kB

Release files / md2slack-0.1.3.2.tar.gz

Download URL md2slack-0.1.3.2.tar.gz
Size 10.3 kB
Tags Source
SHA-256 checksum
How to use checksums
814aa2ee816e28a41fba3c7bff6f006f3dcc0008f46a3cceb5f0281cfc5e4b5f
BLAKE2b-256 checksum
How to use checksums
714a35643cfc46feca21196d2ee0cd83c0287b30f3d8b886086d16e280a03077
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.10.8

Release files / md2slack-0.1.3.2-py3-none-any.whl

Download URL md2slack-0.1.3.2-py3-none-any.whl
Size 9.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8901d5b1df0114d05ffed91ab5b86ef3a76e227887313cb33cff1040e68c5e3a
BLAKE2b-256 checksum
How to use checksums
e966c89f0dfc67e7ee148fd78f44519eb157e6ae25933434c18714aca4b109dd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.10.8

Release history Release notifications | RSS feed

This release

0.1.3.2 This release

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page