Skip to main content

Convert Markdown to Slack-friendly format.

Project description

MD2Slack - Markdown to Slack Converter

GitHub license
GitHub Workflow 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

md2slack-0.1.0.tar.gz (7.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

md2slack-0.1.0-py3-none-any.whl (8.5 kB view details)

Uploaded Python 3

File details

Details for the file md2slack-0.1.0.tar.gz.

File metadata

  • Download URL: md2slack-0.1.0.tar.gz
  • Upload date:
  • Size: 7.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.8

File hashes

Hashes for md2slack-0.1.0.tar.gz
Algorithm Hash digest
SHA256 6dd7e880e4dc6c4f7729ff3b5f6358fa411396281f4ad2d11c8d868d21cdeba6
MD5 d4e13d04008c0c7cfc9343ed6ca2b9db
BLAKE2b-256 2c380dcd574c7629e8064c77df4a9aa86e48a5f1834f1aad6271b894575a85cd

See more details on using hashes here.

File details

Details for the file md2slack-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: md2slack-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 8.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.8

File hashes

Hashes for md2slack-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6708c1b1032c38ca65338fa1a688fb6938db55683c7db976f1906602e009c18b
MD5 71f836ea7355cfd41077686e1651ab78
BLAKE2b-256 52ea6c06558bb20415d73c2b0a9ffe8627439b4fa2baeb4e1f48f0721acf2321

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page