表現.md

0.14.0

API リファレンス

@b4moss/hyogen-md が公開する API の索引です。データソースは 0.12.0、CLI / defineConfig は 0.13.0 から。

レンダリング

API用途パッケージ
renderServerSSR / SSG 向け@b4moss/hyogen-md
renderClientCSR 向け@b4moss/hyogen-md/client
build一括ビルド(SSG)@b4moss/hyogen-md

設定(CLI)

APIパッケージ用途
defineConfig@b4moss/hyogen-md/config`hyogen.config.(js

データソース

API用途
dataSources / loadDataSourcesYAML / JSON / CSV を読みテンプレート変数へバインド

ファイル読み込み

API用途
loaderinclude / component / extend のパス解決
createNodeLoaderNode 用(FS + リモート fetch)
createFsLoaderローカル FS のみ

診断・エラー

API用途
診断とログformatDiagnosticLog、警告の扱い
エラーコードcode 一覧
createHyogenErrorカスタム loader 等でのエラー生成
formatMessageメッセージテンプレートの整形

型とオプション

型とオプション に HyogenContext、RenderOptions、BuildOptions などの要約があります。

設計上の分離

  • サーバー専用データは serverContext で渡します(renderServer / build のみ)
  • クライアントでは serverContext を渡せません(server_context_on_client エラー)
  • ライブラリは console に自動出力しません。ログは呼び出し側が formatDiagnosticLog で整形します