Documentation
BDF is a document format made for previews in the browser. The demo site is the fastest way to see that idea work; the pages below explain why it exists and how the pieces underneath it fit together.
Read next
- Why BDF — what problem this solves, the formats at a glance, page turning, search and accessibility
- Getting started — convert a file and open it, in five minutes
- Integrating into a frontend — show server-produced BDF or convert files in the browser
- Integrating into a server — register only the Go converters your service needs
- Making forms — invoices and slips as BDF documents, from a template (an Excel, Word or PowerPoint file, a PDF with form fields, a template of pdfme) and data, and written as PDF files (tagged and PDF/A too)
- Rendering — draw documents and formulas into a Go
image.Image, with Ebitengine, or on a browser canvas - Build a Wasm runtime — choose converter formats and build for TinyGo or Go
- Formats — every input format, and how BDF lays each one out
- Sample architectures — three ways to fit BDF into a system, each a small server you can run
- Architecture — how conversion and rendering work, formulas and thumbnails, passwords and protected mode, the repository layout, the
bdfcommand, building and testing
Reference (Japanese)
The detailed reference documents are written in Japanese, for now:
Format specification v1.0 — the stable container, manifest, instruction set, and compatibility policy
API reference — every package and command, by name
Design notes — why each converter is built the way it is, section by section
Fonts and licenses — the fonts BDF holds and the demo site serves, and where each comes from (in English and Japanese)
Source
The documentation lives in docs/ as Markdown, next to the code it describes; this site renders it. Corrections and questions are welcome as issues or pull requests.