Skip to main content

A library to convert Markdown to Slack's mrkdwn format

Project description

markdown_to_mrkdwn

MIT License GitHub release (latest by date) PyPI Version PyPI Downloads Python Unit Tests codecov Documentation GitHub Stars

A library for converting Markdown to Slack's mrkdwn format

Features

  • Supports conversion from Markdown to Slack's mrkdwn format
  • Supports nested lists, quotes, inline code, and image URLs

Installation

pip install markdown_to_mrkdwn

Usage

Here's a simple example of how to use the library:

from markdown_to_mrkdwn import SlackMarkdownConverter

converter = SlackMarkdownConverter()
markdown_text = """
# header1
**bold text**
- list
[link](https://example.com)
"""
mrkdwn_text = converter.convert(markdown_text)
print(mrkdwn_text)

Check the output in Slack Block Kit Builder: Slack Block Kit Builder

Contributing

Feel free to send pull requests and issues

License

This project is licensed under the MIT License - see the LICENSE file for details

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

markdown_to_mrkdwn-0.1.3.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

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

markdown_to_mrkdwn-0.1.3-py3-none-any.whl (5.7 kB view details)

Uploaded Python 3

File details

Details for the file markdown_to_mrkdwn-0.1.3.tar.gz.

File metadata

  • Download URL: markdown_to_mrkdwn-0.1.3.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.18

File hashes

Hashes for markdown_to_mrkdwn-0.1.3.tar.gz
Algorithm Hash digest
SHA256 e0d8d890b442ff23db75eb864d9b477a49bbe2bbb683bc1c6304fc4e924eaa6d
MD5 5c06f419632a76c33f152b4ac84e6dd9
BLAKE2b-256 5707ffc4763567796bfa0ec387862cd2873c916e830b25592e2c4aca10531537

See more details on using hashes here.

File details

Details for the file markdown_to_mrkdwn-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for markdown_to_mrkdwn-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 2e53bcdc2e14d94f6925bcdf2688c966c520e6bc0f82bf64f47495dfe56030f5
MD5 79c3cc59b61fb1de83d3f9c49e294828
BLAKE2b-256 f972ce72567662fcb6cc314b6de318298544669fcb56ac87ea19370b3d9429c1

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