Skip to main content

Convert LLM Markdown into Slack Block Kit markdown/table messages

Project description

slack-markdown-parser

slack-markdown-parser is a Python library that converts standard Markdown generated by LLMs into Slack Block Kit messages built from markdown and table blocks.

Why this library exists

Many Slack AI bots have traditionally converted model output into Slack-specific mrkdwn, but that approach creates a few recurring problems:

  • Conversion overhead: LLMs naturally generate standard Markdown, so mrkdwn usually requires extra transformation logic or prompt constraints.
  • Unstable formatting in languages without word spacing: in Japanese and similar scripts, Slack can fail to interpret *, ~, and related markers correctly, exposing the raw punctuation.
  • No table syntax in mrkdwn: Markdown tables need custom fallback rendering if you stay in the old format.

Design approach

This library leans on Slack Block Kit's markdown block for standard Markdown and table block for tables.

Problem Approach
Conversion overhead Send standard Markdown through Slack markdown blocks without rewriting it into mrkdwn.
Formatting instability Insert zero-width spaces (ZWSP, U+200B) around formatting tokens when needed so Slack parses inline styling more reliably without visible extra spaces.
No table syntax in mrkdwn Detect Markdown tables and convert them into Slack table blocks, including repair of common LLM-generated table inconsistencies.

Features

  • Convert standard Markdown into Slack markdown blocks
  • Convert Markdown tables into Slack table blocks
  • Repair common LLM table issues such as missing outer pipes, missing separator rows, mismatched column counts, and empty cells
  • Split output into multiple Slack messages when needed to satisfy Slack's "one table per message" constraint
  • Add ZWSP around inline formatting tokens to reduce rendering issues outside fenced code blocks
  • Build fallback text for chat.postMessage.text from generated blocks

Requirements

  • Your Slack integration must support Block Kit payloads with markdown and table blocks.
  • This library does not help when your delivery path only accepts plain text or mrkdwn strings.

Installation

pip install slack-markdown-parser

Quick start

from slack_markdown_parser import (
    build_fallback_text_from_blocks,
    convert_markdown_to_slack_messages,
)

markdown = """
# Weekly Report

| Team | Status |
|---|---|
| API | **On track** |
| UI | *In progress* |
"""

for blocks in convert_markdown_to_slack_messages(markdown):
    payload = {
        "blocks": blocks,
        "text": build_fallback_text_from_blocks(blocks) or "report",
    }
    print(payload)

convert_markdown_to_slack_messages automatically splits output into multiple messages when the input contains multiple tables.

Rendering example

Example input:

# Weekly Product Update

This week we worked on **search performance** and *UI polish*. The old flow is ~~scheduled for removal~~.
The detailed log ID is `run-20260305-02`.
Reference: https://example.com/changelog

- Improved **API response time**
  - Increased *cache hit rate*
  - Adjusted timeout settings
- Stabilized batch processing
  - Unified retry counts
- Updated documentation

Category | Status | Owner
API | **In progress** | Team A
UI | *Under review* | Team B
QA | ~~On hold~~ | Team C

> Note: production rollout is scheduled for 2026-03-08 10:00 JST

1. Finalize release notes
   1. Unify change labels
   2. Add impact notes
2. Tune monitoring alert thresholds
   1. Update the `warning` threshold
3. Re-check QA

```bash
./deploy.sh production
```

Example Slack bot rendering (markdown + table blocks):

Slack BOT rendering example

Public API

Main functions

Function Description
convert_markdown_to_slack_messages(markdown_text) -> list[list[dict]] Convert Markdown into Slack messages already split around table blocks.
convert_markdown_to_slack_blocks(markdown_text) -> list[dict] Convert Markdown into a flat Block Kit block list.
build_fallback_text_from_blocks(blocks) -> str Build fallback text suitable for chat.postMessage.text.
blocks_to_plain_text(blocks) -> str Convert blocks into plain text.

Utility functions

Function Description
normalize_markdown_tables(markdown_text) -> str Normalize Markdown table syntax before conversion.
add_zero_width_spaces_to_markdown(text) -> str Insert ZWSP around formatting tokens where Slack needs stronger boundaries.
decode_html_entities(text) -> str Decode HTML entities before parsing.
strip_zero_width_spaces(text) -> str Remove ZWSP (U+200B) and BOM (U+FEFF) while preserving join-control characters such as ZWJ.

Lower-level exported helpers

These are also part of the public package surface:

  • add_zero_width_spaces
  • convert_markdown_text_to_blocks
  • extract_plain_text_from_table_cell
  • markdown_table_to_slack_table
  • parse_markdown_table
  • split_blocks_by_table
  • split_markdown_into_segments

Specification and scope

  • Behavior spec: docs/spec.md
  • Japanese behavior spec: docs/spec-ja.md
  • Non-goals:
    • Generating Slack mrkdwn strings
    • Supporting clients or MCP tools that can only send mrkdwn

Contact

License

MIT

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

slack_markdown_parser-2.0.2.tar.gz (13.3 kB view details)

Uploaded Source

Built Distribution

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

slack_markdown_parser-2.0.2-py3-none-any.whl (9.9 kB view details)

Uploaded Python 3

File details

Details for the file slack_markdown_parser-2.0.2.tar.gz.

File metadata

  • Download URL: slack_markdown_parser-2.0.2.tar.gz
  • Upload date:
  • Size: 13.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.9

File hashes

Hashes for slack_markdown_parser-2.0.2.tar.gz
Algorithm Hash digest
SHA256 9de1bbe1aea292413c9b9ac5b3eaea24227133da17b57f9c80454f5a91bb8402
MD5 d63867d3f5f7b0f02610b1a1987de12f
BLAKE2b-256 dc44c0576d7c825ced709622bf32ebcc9ca1136fc89c95418a52fac6523eb6c8

See more details on using hashes here.

File details

Details for the file slack_markdown_parser-2.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for slack_markdown_parser-2.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ae2f6f5bf7ee8af08ca91a9f5b9b449ca80991c874e9f1a07e57aae69fa5e9e3
MD5 995619f377bb6066cdae825737d8cc93
BLAKE2b-256 cecbfb44cf3c27b0d4a2644051904fcfe55cee64fe2aef77d14de24f3c657672

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