@typstream/google-fonts 0.0.0-stage → 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ikram Hasan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,31 @@
-# Temporary Holding Version
+# @typstream/google-fonts
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Any family of the [Google Fonts](https://fonts.google.com) library in typstream documents, by name:
+
+```typst
+#set text(font: "Lora")
+#show heading: set text(font: "Playfair Display")
+#text(font: "Caveat")[Show your working.]
+```
+
+```tsx
+import { googleFonts } from "@typstream/google-fonts";
+
+<Typstream source={text} plugins={[googleFonts]} />;
+// The model learns it may use them:
+buildSystemPrompt([edu, googleFonts]);
+```
+
+- **A font catalogue.** `catalogue.json` lists every family of github.com/google/fonts at one commit, with its TTF files (style, weight or a variable font's weight range, size), served by jsDelivr from that commit. When a document names a family the engine doesn't have, the engine fetches the index (once), downloads the family and compiles the document again. Files over 20 MB, which jsDelivr won't serve, are left out; families over 5 MB (`createGoogleFonts({ maxBytes })`) aren't loaded.
+- **HTML target.** Typst's HTML export drops fonts, so the preamble (`googleFontsPreamble`) marks text in another font than the document's own with its family (`<span data-typstream-font="lora">`), outside equations and frames. `mountTypstream` shows the families the engine loaded as web fonts made from the same files.
+- **Prompt rules.** Exact names, one or two families, and the families that stand in for Arial, Times New Roman, Calibri and others, which aren't in the library.
+- **Network.** Readers' browsers download from `cdn.jsdelivr.net` (allow it in `connect-src`). To avoid that, mirror the files and pass a copy of the index whose `base` points at the mirror: `createGoogleFonts({ index })`.
+
+`node scripts/catalogue.mjs [<commit>]` writes `catalogue.json` again: one GitHub API call for the repository's tree, then each family's `METADATA.pb`.
+
+Docs: [Fonts and languages](https://typstream.vercel.app/docs/guides/fonts-and-languages#any-google-fonts-family), [reference](https://typstream.vercel.app/docs/reference/google-fonts).
+
+## License
+
+MIT. The fonts are downloaded from the Google Fonts library when a document uses them, each under its own license
+(most under the SIL Open Font License); none ship in this package.