PyMdown Mahjong is an extension for Python Markdown designed to support the creation and display of Mahjong-related content. The tool enables users to render individual Mahjong tiles inline, as well as complete Mahjong hands, directly within Markdown documents. It is particularly oriented toward those working with MkDocs and Zensical, offering specialized features for representing complex Mahjong notations and gameplay elements.
The extension allows for inline rendering of tiles by using shortnames, such as ":1p:", and can display entire tile groups or hands using the "mj:" prefix, for example, "mj:123456789m". While inline melds are not currently supported, the tool provides block syntax for writing Mahjong hands inside fenced code blocks. This block syntax can include additional YAML-like options for details such as dora indicators, uradora, and hand titles. The syntax for melds utilizes parentheses for open melds, brackets for closed kan, and specific symbols to indicate meld direction and added kan. PyMdown Mahjong employs standard MPSZ notation for tiles and extends it with Xz notation to represent unknown tiles.
To use PyMdown Mahjong, users must have the SuperFences extension from PyMdown Extensions as a dependency. Installation is performed via pip, and users are instructed to copy a provided CSS file to their stylesheets directory for proper rendering. Configuration options include setting the theme (auto, light, or dark) and the style for closed kan (outer or inner), with clear defaults and descriptions provided for each.
PyMdown Mahjong is delivered as a Python package and integrates with Markdown workflows, especially those involving MkDocs.
PyMdown Mahjong sits in PulseGate's Frameworks & SDKs category. It focuses on enabling easy rendering of Mahjong tiles and hands in Markdown documentation. It is built as an open-source project for markdown users and Mahjong content creators. PyMdown Mahjong is open source under the CC-BY-NC-4.0 license. PyMdown Mahjong is available on the web and the command line.
It is developed by tylernguyen, and the product first shipped in 2026. Development happens publicly on GitHub with 22 commits in the last 90 days. Key capabilities include mahjong tile rendering, markdown extension, and inline syntax support.
Latest indexed changes and source events
Other apps tracked under the same category.
