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.2.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.2-py3-none-any.whl (5.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: markdown_to_mrkdwn-0.1.2.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.2.tar.gz
Algorithm Hash digest
SHA256 8593794f93ea816c4fa067eb22590bab40c45b7531e175b317d7ead0b2b54299
MD5 7437ef4c79c4725cd47da251b2d98ec0
BLAKE2b-256 8d492fd03d2a227da459a5ea9d088aba8f5e7dfc6ccf865b9f6c072e18d205ac

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for markdown_to_mrkdwn-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 cceed51b7caf3c0c7ffd0dabda39b130cbecf37bd785c12989e5e8fee993368b
MD5 511931c8a9cbd26d78eadb99b3edc207
BLAKE2b-256 8fef226bcc5d8072d93c2e83d5016f5e00b08df055fd9d8698bf496b5534068f

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