JZFM Playground

Japanese (Zenkaku) Flavored Markdown — ○見出し○ / ①② / 第１→1→(1)→ア / 拝啓〜敬具 / 記〜以上 などの JTC / 公用文記法と markdown を unified pipeline で受けて JTC 表記で表示するガラパゴス markdown 方言。

Demo

https://carrotrakko.github.io/jzfm-playground/ (GitHub Pages、 main branch / root)

動かす

index.html をブラウザで開くだけ (CDN で marked.js を取りに行くのでネット要)。

git clone https://github.com/carrotRakko/jzfm-playground.git
open jzfm-playground/index.html

ローカル静的サーバを立てる場合:

cd jzfm-playground && python3 -m http.server 8000
# → http://localhost:8000/

サポート記法 (概要)

• 見出し: ○タイトル○ / ○○タイトル○○ / ○○○タイトル○○○ (○ の数で h レベル)
• 並列列挙: ①〜⑳ / ・ / ○ ● ◎ ■ □ ★ ☆ ◆ ◇ (markdown bullet - / * / + も ・ で表示)
• 階層リスト (公用文 7 階層): 第１ → 1 → (1) → ア → (ア) → a → (a) (markdown 1. 入れ子も同じ出力)
• 結びブロック: 記 ... 以上 (1 枚もの書類風)、 拝啓 ... 敬具 / 前略 ... 草々 (手紙体裁)
• 注釈: 行頭 ※ / (注) / （注） / ＊
• リンク: 「テキスト」（URL）

詳細仕様 + 各項目の対応状況 + 内輪 design note: SPEC.md

設計方針 (C')

単一の unified pipeline:

• 入力: JTC / 公用文記法 + 既存 markdown 記法 の 和集合
• 出力: 常に JTC 表記 (mode 切り替えなし、 unified)
• どちらの記法で書いても同じ JTC 出力 → 既存 markdown 文書を JTC で読み返す reader としても使える

着想

kmizu (@kmizu) on X のツイートが直接の発端:

割と冗談でなく、 日本人の非エンジニアに markdown ぽいのを受け入れてもらうなら

• 番号付きリスト: ①、 ②、 ③、 ④...を使ってもらう
• 箇条書き: ・から始まる行
• 段落: 空行
• 見出し: ○見出しタイトル○
• リンク: 「サンプル」(example.com)

ガラパゴス markdown としては結構ありじゃないかな

このアイデアに乗って、 「Japanese (Zenkaku) Flavored Markdown (JZFM)」 として広げてみた playground。 kmizu さんの提示した 5 記法に加えて、 公用文 7 階層、 拝啓〜敬具、 記〜以上、 注釈マーカーなど JTC でよく見る記法を受け入れる方向に拡張。 入力は JTC / markdown の和集合、 出力は JTC 表記で統一する unified pipeline。

「JTC Flavored Markdown」 という呼び方は同スレッド内の @take_cheeze さんの表現由来。

出典

• 公用文 7 階層: 公用文作成の考え方 (文化審議会 建議)
• 項番ルール: 取説やビジネス文書の項目番号の付け方
• 記 / 以上: 「記書き」 って何？ ビジネス文書における 「記」 と 「以上」 の正しい使い方 (@DIME)

ライセンス

MIT