Skip to main content

A library to convert Markdown to Slack's mrkdwn format

Project description

markdown_to_mrkdwn

Documentation Status

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for markdown_to_mrkdwn-0.1.0.tar.gz
Algorithm Hash digest
SHA256 db109d1ddb503eecbe2ef7fd4842b2600ade9b536a245ca66e42570b2f35f7ed
MD5 5130dbfb0121c19cfeb7ee1acc33234f
BLAKE2b-256 b65e38a562504afbcdeb61b22dd227ab2f19108db923ecabf46b591cded551d7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for markdown_to_mrkdwn-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9b497f08af758317495fe7afbf6592a1efefd201fb86826987d1f571acce12ab
MD5 9abb2bc815ea0dee080d5ec9c2744329
BLAKE2b-256 1b352ed867b78b8d8092aa6c7cc54cb2cde07e7c6abade53261630e860c22fc0

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