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

Uploaded Python 3

File details

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

File metadata

  • Download URL: md2slack-0.1.2.6.tar.gz
  • Upload date:
  • Size: 9.8 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.6.tar.gz
Algorithm Hash digest
SHA256 deaf447ba03ec35c958fd7d64a4b4c673a599a169cd736fe3f0e735cfcfa14e7
MD5 891c72e645a593afd3d39a162f0cb1d2
BLAKE2b-256 e704f272ac87f011b414e71696f54c74be94c98bd32682975bf664466fd38155

See more details on using hashes here.

File details

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

File metadata

  • Download URL: md2slack-0.1.2.6-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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 696bec78159dd8d6bcf531db650470bdafaf8c94c9dcb7d364306cbaea37a438
MD5 6ae7de17536e7d5989668f962c8f91c4
BLAKE2b-256 cdb37e375200871be49699decd94ee5b1320659b3b39c6ebd02c6e656f60c6dd

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