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 Python Unit Tests codecov Documentation GitHub Stars

MarkdownをSlackのmrkdwn形式に変換するライブラリです。

特徴

  • MarkdownからSlackのmrkdwn形式への変換をサポートします。
  • ネストされたリストや引用をサポートします。
  • インラインコードや画像を処理します。

インストール

pipを使用してパッケージをインストールできます。

pip install markdown_to_mrkdwn

使用方法

ライブラリの簡単な使用例を以下に示します。

from markdown_to_mrkdwn import SlackMarkdownConverter

converter = SlackMarkdownConverter()
markdown_text = """
# ヘッダー1
**太字のテキスト**
- リスト項目
[リンク](https://example.com)
"""
mrkdwn_text = converter.convert(markdown_text)
print(mrkdwn_text)

Slack Block Kit Builderで出力を確認してください: Slack Block Kit Builder

コントリビューション

遠慮なくpull request・issue等お送りください

ライセンス

このプロジェクトはMITライセンス(LICENSE)の下でライセンスされています。

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for markdown_to_mrkdwn-0.1.1.tar.gz
Algorithm Hash digest
SHA256 9121bf948fa29e855d09588b47347fc1d9923baec82cda34303f96f33e4994dd
MD5 987b5fd8969018686d7b5200ec5f1e7a
BLAKE2b-256 2d99ce719659f42a8fd7912b988aa616a2177c725d2f7ebf35aad0699709689d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for markdown_to_mrkdwn-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3ed6f27a7bb2b4f48686e0be4edf8f58cc2ffe4942f77841dce4c2e42b24009b
MD5 0c6fa834e598dd9da7879ec1f0bf3c78
BLAKE2b-256 9f924f11e1f40c130f071f57af05615fb9ea56610b80a7668acd7fc695f7a45f

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