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.2.4.tar.gz (9.3 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.2.4-py3-none-any.whl (9.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: md2slack-0.1.2.4.tar.gz
  • Upload date:
  • Size: 9.3 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.2.4.tar.gz
Algorithm Hash digest
SHA256 dd8d3ea4c5e1c7f03f25f3e25e5f00183b79d805aa0d3e2efd78b36f0b72c7ff
MD5 4a5a140c8b87ab626a5498ac4ac88e55
BLAKE2b-256 9a61a4e635060f691f482461823df0e6b62c97f3853d6de00d492717ff954bb0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: md2slack-0.1.2.4-py3-none-any.whl
  • Upload date:
  • Size: 9.4 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.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 b04e572f3c74e4608092b1cff087d6c2ad47b4a7273bb96fedbfe82b50d607b5
MD5 c90f833c878cb15a0f150d0f1620d70c
BLAKE2b-256 e31a788365d86128fe829648fa7696a09c6246eb95f795bf1a81f15ec0fa9ed7

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