About these docs
This is the user documentation of Fontra, written by its users and developers. It is open source and licensed CC BY 4.0; every page has an Improve this page link at the bottom.
How it is organized
The docs follow the Diátaxis system: tutorials take you by the hand (learning), how-tos solve one problem (doing), the reference describes every surface of the app precisely (looking up) and the explanations discuss the ideas behind it (understanding). Two more sections serve people arriving from elsewhere: Migrate, for Glyphs and RoboFont users, and Workflow, for the command-line pipeline tool. Documentation overview says more about how the pages are written.
Reading the badges
A page marked Planned is an outline, not content: the sidebar and the hub cards show the badge, and the page says so at the top. A passage tagged verify is a claim to check against the current Fontra build. Striped frames mark where a short screen recording will go.
Still to write
Every page declares its state in its front matter (status: ready or status: planned); this list is generated from it at build time.
| Page | Section |
|---|---|
| Action reference | workflow |
| Writing your own actions | workflow |
Contributing
- Fix a typo or improve a sentence: Improve this page on GitHub, at the bottom of every page, opens the source file for editing.
- Report a problem with Fontra itself: see Reporting bugs, feature ideas, etc..
- Add a page: the source lives at fontra/fontra-docs; pages are Markdown with a
permalink:and astatus:in their front matter, and the navigation is one tree in_data/nav.js. Existing URLs are never changed, and the build checks that every one of them still resolves.
Fontra Tutorials, in the editor
The Fontra Tutorials plug-in puts guided tours and lessons inside Fontra, with a bubble on each part of the real interface. Its tours link back to these pages. Add the address uplus-type/fontra-tutorials in the Plugin manager; the same tours are built into Try Fontra.