Skip to main content

Markdown/AsciiDoc から美しい日本語文書 (HTML/PDF) を作る — 日本語組版CSS・CJKフレンドリー・Chrome印刷

Project description

pywashi

日本語 | English | 繁體中文 | 한국어

Markdown から美しい日本語文書 (HTML / PDF) を作るコマンド washi。 横書きのビジネス文書から、縦書きの小説、原稿用紙まで、 コマンド一つで日本語らしく組む。

(PyPI/Python パッケージ名は pywashi。CLI コマンド名は washi のまま。 旧名 washi-md から改称 — "md" が markdown の略語で冗長だったため、 かつ短い washi は既に別プロジェクトが登録していたので pywashi に)

pip install pywashi

washi report.md          # → report.html (組版済み・自己完結・1ファイル)
washi report.md --pdf    # → report.pdf も出力 (Chrome/Chromium ヘッドレス印刷)

なにが「綺麗」になるか

  • フォントは モリサワUD を最優先: 商用の UD黎ミン/UD新ゴ (Morisawa Fonts) がインストールされていればそれを使い、無ければ BIZ UD → ヒラギノ/Noto の順で フォールバック。--embed-fonts DIR で BIZ UD の woff2 (SIL OFL) を HTML に 埋め込めば、フォントの無い相手の環境でも同じ見た目になる
  • 日本語組版CSS を同梱: 本文は明朝・両端揃え・段落頭一字下げ・行間1.9、 見出しはゴシック、行頭禁則 (line-break: strict)、約物の行頭詰め (text-spacing-trim)、句読点のぶら下げ
  • CJKフレンドリーな Markdown 解釈 (mdit-py-cjk-friendly): 文中改行が空白にならない・全角括弧に隣接した強調が効く
  • 印刷/PDF対応: @page で A4・余白・ページ番号。表・コード・見出しの ページまたぎを抑止。--pdf は Chrome ヘッドレスで生成 (追加依存なし)
  • 縦書きと原稿用紙: --vertical で右→左の縦組 (縦中横つき)、 --genko で1字1マスの原稿用紙 (縦横両対応)
  • ふりがな: {漢字|かんじ} (グループルビ)・{東京|とう|きょう} (モノルビ) — でんでんマークダウン形式。縦書きでもそのまま効く
  • 傍点・傍線: [テキスト]{.sesame_dot} (Pandoc 風クラス付きスパン) — ゴマ点・丸・三角・二重丸・蛇の目・ばつの傍点と実線〜波線の傍線の CSS を 同梱。横書き・縦書き両対応
  • AsciiDoc入力にも対応(要 pyasciidoc--format asciidoc または .adoc/.asciidoc 拡張子で自動判定): 見出し・強調・admonition・箇条書きに加え、ふりがな・傍点も本文中に そのまま書ける(AsciiDoc自体には無い記法をwashi側から合成)
  • frontmatter (title / author / date) から表題部を生成

使い方

washi INPUT.md [-o OUTPUT.html] [--title 表題] [--pdf]
      [--theme default|textbook|gothic|maru|bungei]
      [--vertical] [--genko]
      [--font-serif NAME] [--font-sans NAME] [--webfonts]
      [--css FILE ...] [--no-base-css] [--embed-fonts DIR]
      [--format markdown|asciidoc]

Python から:

from pywashi import render
html = render(markdown_text, title="報告書")
html = render(asciidoc_text, title="報告書", format="asciidoc")  # 要 pyasciidoc

AsciiDoc入力

pip install "pywashi[asciidoc]"   # または pip install pyasciidoc を別途

washi report.adoc            # 拡張子で自動判定 (.adoc/.asciidoc → asciidoc)
washi report.md --format asciidoc   # 拡張子によらず明示指定

見出し(= Title)・強調(*strong*/_em_)・admonition(NOTE:等)・ 箇条書き(* item/. item)はAsciiDoc構文(pyasciidocが解釈)、 ふりがな・傍点はwashi独自の記法のまま本文中にそのまま書ける (AsciiDoc自体には無い機能をwashi側から合成しているため)。 --vertical/--genko/テーマ等、Markdown入力と全く同じオプションが使える。

縦書き

washi 小説.md --vertical --theme bungei --pdf

--vertical で本文が縦書き (右→左) になる。1〜2桁の数字は自動で 縦中横、表とコードブロックは横書きのまま埋め込まれる。 bungei テーマと組み合わせると小説・随筆向けの組版になる。

原稿用紙にもできる (縦横どちらでも):

washi 作文.md --genko --pdf              # 横書き原稿用紙
washi 作文.md --genko --vertical --pdf   # 縦書き原稿用紙 (20字/行)

1字1マスのグリッドに全角ベタ組で流し込む。半角英数は自動で全角化。 字数を変えるには --cssbody.genko { --genko-cols: 25; } を渡す。

テーマとカスタムCSS

  • --theme textbook — 本文をUDデジタル教科書体に (学習教材向け。行間2.0)
  • --theme gothic — 本文ゴシック・字下げなし (ビジネス文書・報告書風)
  • --theme maru丸ゴシック (Zen Maru Gothic。お知らせ・案内文のやわらかい文書)
  • --theme bungeiオールド明朝 (Shippori Mincho。文芸・随筆の趣)
  • --webfonts — Google Fonts を読み込み、フォント未導入の環境でもテーマの 書体で表示 (BIZ UD も Google Fonts にあるため default テーマにも効く。 オフラインでは効かないので、自己完結にしたい場合は --embed-fonts を使う)
  • --font-serif "A1明朝" / --font-sans "新ゴ M"インストール済みフォントを 名前で直接指定。Morisawa Fonts (Select 8 等) で入れた書体がCSSなしで使える。 PDF生成もローカルレンダリングなのでそのまま効く
  • ユーザーテーマ: ~/.config/pywashi/themes/○○.css に置くと --theme ○○ で使える (同名なら同梱テーマより優先)。お気に入りの 書体構成を場面別に保存しておける
  • --css my.css — 自分のCSSを同梱CSSの後に追加 (自分のルールが優先。繰り返し可)
  • --no-base-css — 同梱CSSを使わず完全に自分のCSSで組む
from pywashi import render
html = render(md_text, theme="textbook", extra_css=[Path("my.css")])

ロードマップ

  • docx 出力 (美しい日本語 reference-doc)
  • AI が出力した Markdown の整形 (フォーマッタ)

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

pywashi-0.9.5.tar.gz (30.2 kB view details)

Uploaded Source

Built Distribution

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

pywashi-0.9.5-py3-none-any.whl (20.2 kB view details)

Uploaded Python 3

File details

Details for the file pywashi-0.9.5.tar.gz.

File metadata

  • Download URL: pywashi-0.9.5.tar.gz
  • Upload date:
  • Size: 30.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pywashi-0.9.5.tar.gz
Algorithm Hash digest
SHA256 655d9f9110b738edec9ae168fe51d06b0a2a9d0c387065e0796e28a336165374
MD5 75f4a5233e51c452829586da119f1eb0
BLAKE2b-256 c2adbc6b5b31403ee2b960533d386ab20a2c8573962ce316175839b958c8f877

See more details on using hashes here.

Provenance

The following attestation bundles were made for pywashi-0.9.5.tar.gz:

Publisher: publish.yml on aiseed-dev/pywashi

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pywashi-0.9.5-py3-none-any.whl.

File metadata

  • Download URL: pywashi-0.9.5-py3-none-any.whl
  • Upload date:
  • Size: 20.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pywashi-0.9.5-py3-none-any.whl
Algorithm Hash digest
SHA256 a72223127d84b149c9e022f4453f6d1dc9699c9a9f26ac59573cd87de7711499
MD5 cadad9fefcf2f7fb9e76a5b665ccd3b2
BLAKE2b-256 78f72dd9c03316c737ae300c5167fe241c6a02b22110888692ae969bfc735161

See more details on using hashes here.

Provenance

The following attestation bundles were made for pywashi-0.9.5-py3-none-any.whl:

Publisher: publish.yml on aiseed-dev/pywashi

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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