Basho (芭蕉) is a vertical Japanese typesetting (tategaki / 縦書き) package for Typst. It handles character boxes, tate-chu-yoko (TCY), ruby (furigana), automatic pagination, multi-column RTL layout, and kinsoku shori (Japanese line-breaking rules).

Usage

Minimal example

#import "@preview/basho:0.1.0": tate

#set text(font: "Harano Aji Mincho")
#set page(paper: "jp-business-card")

#show: tate

閑さや

　岩にしみ入る

　　蝉の声

Full example

An extended example with various features is available here. An example of Japanese novel typeset is available here.

Inline macros

Inline rendering

#tate-inline(body, config) renders content as a vertical stack without pagination — useful inside #hblock[...] or other upright contexts.

Customization

Basho accepts a config dictionary on #tate() to tweak layout and rendering:

#tate(config: (
  layout: (columns: 2, paragraph-indent: 1.5em),
  sizing: (char-box: 1.2em),
))[...]

See docs/configuration.md for the full options reference and docs/extending.md for custom modules.

Feature peek

#import "@preview/basho:0.1.0": hblock, ruby, tate, vblock
#set text(font: "Harano Aji Mincho")
#set page(width: 450pt,height: 350pt)


#tate(config: (layout: (columns: 2)))[
  = ポラーノの広場

  そのころわたくしは、モリーオ市の博物局に勤めて居りました。
  　十八等官でしたから役所のなかでも、ずうっと下の方でしたし#ruby("俸給", "ほうきゅう")もほんのわずかでしたが、受持ちが標本の採集や整理で生れ付き好きなことでしたから、わたくしは毎日ずいぶん愉快にはたらきました。殊にそのころ、モリーオ市では競馬場を植物園に#ruby("拵", "こしら")え直すというのでその景色のいいまわりにアカシヤを植え込んだ広い地面が、切符売場や信号所の建物のついたまま、わたくしどもの役所の方へまわって来たものですから、わたくしはすぐ宿直という名前で月賦で買った小さな蓄音器と二十枚ばかりのレコードをもって、その番小屋にひとり住むことになりました。わたくしはそこの馬を置く場所に板で小さなしきいをつけて一疋の山羊を飼いました。毎
]

#import "@preview/basho:0.1.0": hblock, ruby, tate, vblock
#set text(font: "Harano Aji Mincho")
#set page(width: 450pt,height: 350pt)

#tate[
  == Fourier変換
  次によって定義されるFourier変換
  $
    integral_(-oo)^(oo) f(x) e^(-2 pi i k x) d x, quad "where" x, k in R
  $
  は位置空間$x$から波数空間$k$への変換である。

  == 形容詞の活用表
  #hblock(table(
    columns: 2,
    tate[ク活用], [],
    tate[から], tate[未然形],
    tate[かり], tate[連用形],
    tate[◯], tate[終止形],
    tate[かる], tate[連体形],
    tate[かれ], tate[命令形],
  ))

  == 短冊
  #rect(
    fill: rgb(255, 240, 240),
    tate(
      [奥山に 紅葉踏みわけ 鳴く鹿の

        声きく時ぞ 秋は悲しき],
    ),
  )
]

Architecture

Basho renders vertical text through a 5-stage pipeline built on a Dependency Injection architecture — every component (rendering transforms, TCY classification, kinsoku rules, list modules) is pluggable via a single config dictionary.

flowchart LR
    Input["Input content"] --> Flatten["1. Flatten"]
    Flatten --> Transform["2. Transform"]
    Transform --> Classify["3. Classify"]
    Classify --> Paginate["4. Paginate"]
    Paginate --> Render["5. Render"]
    Render --> Output["Output"]

Learn more

License

MIT