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

Uploaded Python 3

File details

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

File metadata

  • Download URL: md2slack-0.1.2.tar.gz
  • Upload date:
  • Size: 8.1 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.tar.gz
Algorithm Hash digest
SHA256 5221adfb24611961f4253498fe066fb4a25274a0aead76d40f1f65e9b3a4fefb
MD5 4ee2a1aaf42b6a64a66c2614ddf8974c
BLAKE2b-256 78126f40bcf190da6db2f9d65293d68318d358a50253398b03b3a61e32727a56

See more details on using hashes here.

File details

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

File metadata

  • Download URL: md2slack-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 8.8 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-py3-none-any.whl
Algorithm Hash digest
SHA256 0676ced2ac981e9e966ea8dbbc13a22c4114bcea0ade8ae3a164723bc2870b1c
MD5 9aca22acc0a45bf6192b35b9a064267a
BLAKE2b-256 d1fd45b89514941a123d54b36f7bfa467ba7f1a0c66ecdd7d2332a4961e57c5d

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