本文へスキップ

API リファレンスのデモ

グループ分けしたサイドバーとパッケージ表を備えたライブラリのリファレンスです。

パッケージ
名前バージョンリンク
modootoday-core解析、変換、ページモデル。 1.4.0
modootoday-climodootoday コマンド。 1.4.0
modootoday-lintページをレイアウトの約束事と照らし合わせて検査します。 0.9.2

サイドバーはメンバーを group: でまとめ、表はライブラリを構成するパッケージを示します。

ヒント

表とメンバーの説明がずれないよう、パッケージは同じマイナーバージョンに固定してください。

build

modootoday build [--drafts]

サイトを _site にビルドします。

serve

modootoday serve [--port N]

サイトをビルドして配信し、変更があれば再ビルドします。

Site.load

Site.load(path) -> Site

path 以下の設定とページを読み込みます。

Site#render

site.render(page) -> String

1 つのページを HTML に変換します。

Page#data

page.data -> Hash

ページの front matter です。