This repository contains the source files for a community maintained set of package API guidelines. It is intended for developers across the Typst ecosystem to help them create packages and templates with easy-to-use and consistent APIs. The guidelines are not hard rules, nor are they prefect, contributions and discussions to improve them are welcome.
Note
This document is currently a draft, chapters and sections may change or be removed at any point.
If you wish to fix grammatical errors or improve the layout or appearance of the document feel free to open a PR directly. If you wish to propose a change to the guidelines itself, please open an issue to discuss the changes with the community. Everyone is welcome to discuss changes to the guidelines.