ドキュメント

BDF はブラウザでのプレビューのために作られた文書フォーマットです。実際に動くところを見るならデモサイトが一番早く、なぜそれがあるのか、各部がどうつながっているのかは、この下のページで説明します。

次に読むもの

• なぜ BDF か — どんな問題を解決するか、対応形式の一覧、ページめくり・検索・読み上げ
• はじめかた — ファイルを変換して開くまで、5 分で
• フロントエンドに組み込む — サーバー変換済み BDF の表示とブラウザ内変換
• サーバーに組み込む — 必要な形式だけを登録する Go の変換サーバー
• 帳票を作る — Excel・Word・PowerPoint のテンプレート、入力欄のある PDF、pdfme のテンプレートとデータから、請求書や伝票を BDF として作り、PDF（タグ付き、PDF/A も）に書き出す
• 描画する — 文書と数式を Go の image.Image、Ebitengine、ブラウザの Canvas に描く
• Wasm ランタイムをビルドする — 形式を選んで TinyGo または Go でビルド
• 対応形式 — すべての入力形式と、それぞれのレイアウト
• 構成のサンプル — BDF をシステムに組み込む 3 つの方法。それぞれ実際に動く小さなサーバーです
• アーキテクチャ — 変換と描画の仕組み、数式やサムネイル、パスワードと保護モード、フォルダ構成、BDF コマンド、ビルドとテスト

リファレンス（日本語）

詳しいリファレンスは今のところ日本語のみです。

• フォーマット仕様 v1.0 — 安定版のコンテナ、manifest、命令セットと互換性方針

• API 一覧 — パッケージとコマンドの一覧

• 設計メモ — 各変換器がその作りになっている理由

• フォントとライセンス — BDF が含むフォントとデモサイトが配るフォント、それぞれの出元

ソース

ドキュメントは docs/ に Markdown として置かれ、説明する対象のコードのそばにあります。このサイトはそれを描画したものです。訂正や質問は issue や pull request で歓迎します。