Skip to main content

Convert Markdown to Slack-friendly format.

Project description

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.

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.3.1.tar.gz (10.2 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.3.1-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: md2slack-0.1.3.1.tar.gz
  • Upload date:
  • Size: 10.2 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.3.1.tar.gz
Algorithm Hash digest
SHA256 f4d7999a58389362f22450f3e43a44b526027f293049544d182d21af962b8e43
MD5 365f76ab65eeb07a7a2bf42e0bee227d
BLAKE2b-256 0a1ca72d277e49e076e09416dbc988ced7b3c5e567b65c2ee0ae9ba38a082e80

See more details on using hashes here.

File details

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

File metadata

  • Download URL: md2slack-0.1.3.1-py3-none-any.whl
  • Upload date:
  • Size: 9.7 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.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5b023688c0f8ccc04f774b38994ba6b17dc10204677095528ce449e0fd85cff1
MD5 fc6303061283446de5f720dbc57c7940
BLAKE2b-256 4d0aad0696379992447ceda4760500b7646b9a6e03f1fbb70cf6c566287750fa

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