Skip to content
Back to search

loom-notes

A gorgeous XeLaTeX class + Claude skill for fill-in study notes — read and fill, learn by active recall.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/polaris-aeterna--loom-notes/badge.svg)](/listings/polaris-aeterna--loom-notes)

HTML

<a href="/listings/polaris-aeterna--loom-notes"><img src="/api/listings/polaris-aeterna--loom-notes/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

git clone https://github.com/Polaris-Aeterna/loom-notes.git
cd loom-notes/template
latexmk -xelatex main.tex      # or: xelatex main.tex (twice)

Then write. A blank starter, doubling as a live cheat-sheet of every command, is in [`template/main.tex`](template/main.tex). Open the repo in **VS Code** and the bundled [`.vscode/settings.json`](.vscode/settings.json) builds with XeLaTeX on every save (LaTeX Workshop defaults to pdflatex, which fails here).

> **Requirements.** XeLaTeX (TeX Live 2023+). Libertinus ships with TeX Live; > Optima / Avenir Next / Songti / 楷体 are macOS system fonts. On other platforms, > swap the three `\newfontfamily` lines in [`loom.cls`](loom.cls) for any display > sans — everything else stays.

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 156 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. <div align="center">
  2. # 🧶 Loom
  3. ### Weave your understanding — a gorgeous XeLaTeX class for **fill-in study notes**
  4. *Notes you both **read** and **fill**: statements and intuition to take in,
  5. blanks and proof-skeletons to work out. Learn by active recall, on paper that
  6. looks like an illuminated manuscript.*
  7. <img src="gallery/cover.png" width="320" alt="A Loom cover: a woven tri-colour emblem above an Optima title.">
  8. [![License: MIT](https://img.shields.io/badge/License-MIT-A23B2E.svg)](LICENSE)
  9. ![Engine: XeLaTeX](https://img.shields.io/badge/engine-XeLaTeX-27406B.svg)
  10. ![Made with Loom](https://img.shields.io/badge/woven%20on-Loom-BE8A20.svg)
  11. </div>
  12. ---
  13. ## Why Loom
  14. Most notes are **read-only**: definition → theorem → proof, flowing past your
  15. eyes. You finish the page and remember nothing. Loom typesets the *other* layer
  16. too — **the weave of your own understanding**:
  17. - 🧵 **A page is cloth on a loom.** *Warp* threads are the ideas in play (a left
  18. selvage rail). *Knots* are results that bind them (theorem boxes). *Loose
  19. threads* are your open questions. A *warmth gauge* records how well you actually
  20. grok each block.
  21. - ✍️ **Passive + active in one document.** The exposition is written to be **read**;
  22. the high-value steps are left **blank** (`\fillin`), proofs ship as **skeletons**
  23. (`\TODO`), and the book's examples are restaged as **"your turn"** computations.
  24. The source is your answer key.
  25. - 🎨 **Dyed in real pigments.** Indigo, madder, weld, iron-gall — historical
  26. textile and ink dyes no maths template uses. Headings incised in Optima, body
  27. and math in Libertinus, 中文 in Songti/楷体. Every cover carries a
  28. procedurally-woven emblem.
  29. - 🤖 **An AI skill that writes them for you.** Point Claude at a chapter and the
  30. [`fill-in-notes` skill](skill/SKILL.md) produces a complete, compiling notebook
  31. in this style — organized around a *spine*, not transcribed.
  32. <div align="center">
  33. <table>
  34. <tr>
  35. <td><img src="gallery/svd.png" width="330" alt="Singular Value Decomposition"></td>
  36. <td><img src="gallery/fourier.png" width="330" alt="The Fourier transform"></td>
  37. </tr>
  38. <tr>
  39. <td align="center"><em>Singular Value Decomposition — a definition knot, the geometry, a <b>Your&nbsp;turn</b></em></td>
  40. <td align="center"><em>Fourier transform — the dictionary, the convolution theorem</em></td>
  41. </tr>
  42. <tr>
  43. <td><img src="gallery/entropy.png" width="330" alt="Entropy"></td>
  44. <td><img src="gallery/gradient-descent.png" width="330" alt="Gradient descent"></td>
  45. </tr>
  46. <tr>
  47. <td align="center"><em>Entropy — the information diagram, Gibbs' inequality</em></td>
  48. <td align="center"><em>Gradient descent — the rate, and the cost of conditioning</em></td>
  49. </tr>
  50. <tr>
  51. <td><img src="gallery/concentration.png" width="330" alt="Concentration of measure"></td>
  52. <td><img src="gallery/demo-content.png" width="330" alt="Every visual feature"></td>
  53. </tr>
  54. <tr>
  55. <td align="center"><em>Concentration of measure — theorem stated, proof left as a skeleton</em></td>
  56. <td align="center"><em>Every device on one page (the demo)</em></td>
  57. </tr>
  58. </table>
  59. </div>
  60. ## Quickstart
  61. ```bash
  62. git clone https://github.com/Polaris-Aeterna/loom-notes.git
  63. cd loom-notes/template
  64. latexmk -xelatex main.tex # or: xelatex main.tex (twice)
  65. ```
  66. Then write. A blank starter, doubling as a live cheat-sheet of every command, is
  67. in [`template/main.tex`](template/main.tex). Open the repo in **VS Code** and the
  68. bundled [`.vscode/settings.json`](.vscode/settings.json) builds with XeLaTeX on
  69. every save (LaTeX Workshop defaults to pdflatex, which fails here).
  70. > **Requirements.** XeLaTeX (TeX Live 2023+). Libertinus ships with TeX Live;
  71. > Optima / Avenir Next / Songti / 楷体 are macOS system fonts. On other platforms,
  72. > swap the three `\newfontfamily` lines in [`loom.cls`](loom.cls) for any display
  73. > sans — everything else stays.
  74. ## On Overleaf
  75. The root `loom.cls` relies on macOS fonts, so two Overleaf-ready editions live
  76. under [`overleaf/`](overleaf/) — both keep `\documentclass{loom}` and the full
  77. command set (set the compiler to **XeLaTeX**):
  78. | | font setup | upload? |
  79. |---|---|---|
  80. | [`overleaf/libertinus/`](overleaf/libertinus/) | all-Libertinus + Noto CJK — body & math match the original | **nothing to upload** |
  81. | [`overleaf/classico/`](overleaf/classico/) | URW Classico (closest to the Optima look) — *contributed by [fn-gn](https://github.com/fn-gn)* | 4 font files, you supply |
  82. Most people want [`overleaf/libertinus/`](overleaf/libertinus/): copy it into a
  83. project, compile, done.
  84. ## The toolkit (all built into the class)
  85. | you want… | you write… |
  86. |---|---|
  87. | the woven cover | `\loomcover{title}{sub}{author}{date}` |
  88. | a result / definition / example | `theorem` · `definition` · `example` (auto-styled knots) |
  89. | the intuition voice | `strand` env, `\whisper{…}`, `\keyword{…}` |
  90. | **a blank to fill** | `\fillin[width]` |
  91. | **a proof gap** | `\TODO{the missing step}` |
  92. | **a do-it-yourself box** | `yourturn` env + `\workspace[n]` ruled lines |
  93. | **how well you grok it** | `\warmth{0..5}` |
  94. | a margin recall prompt | `\recall{question}` |
  95. | an open thread / a recurring object | `\loose{…}` · `\warp{key}` / `\pick{key}` |
  96. Full reference: [`skill/reference/loom-commands.md`](skill/reference/loom-commands.md).
  97. ## The AI skill
  98. [`skill/`](skill/) is a Claude skill that turns a textbook chapter, lecture, or
  99. paper into a finished Loom notebook: it finds the **spine**, drafts each section in
  100. the Loom grammar, engineers the gaps at the right density (~70% read / 30% fill),
  101. compiles, and verifies. See [`SKILL.md`](skill/SKILL.md), and the hard-won XeLaTeX
  102. gotchas in [`reference/pitfalls.md`](skill/reference/pitfalls.md).
  103. ## Examples
  104. The first four are **original expositions of public-domain mathematics** — one each from linear
  105. algebra, signals, information, and optimization — safe to learn from and to share.
  106. | | the spine |
  107. |---|---|
  108. | [`examples/svd/`](examples/svd) | **the Singular Value Decomposition** — *"ask a matrix anything; read the answer off Σ"* |
  109. | [`examples/fourier-transform/`](examples/fourier-transform) | **the Fourier transform** — *"Fourier is the eigenbasis of shift"* |
  110. | [`examples/entropy/`](examples/entropy) | **entropy** — *"the price of uncertainty: you can't pay less, you needn't pay more"* |
  111. | [`examples/gradient-descent/`](examples/gradient-descent) | **gradient descent** — *"the rate is a tax on conditioning"* |
  112. | [`examples/concentration-of-measure/`](examples/concentration-of-measure) | concentration of measure — proof-skeleton style, organized "by engine" |
  113. | [`examples/nonlinear-algebra/`](examples/nonlinear-algebra) | nonlinear algebra, Ch. 1–2 — closely follows Michałek–Sturmfels (GSM 211); cite the book |
  114. | [`examples/demo/`](examples/demo) | every visual feature on two pages |
  115. ## License & credits
  116. Code (the `loom.cls` class and the skill): **MIT** — see [LICENSE](LICENSE). Use it,
  117. fork it, re-dye it.
  118. The example **notebooks** are study notes that restate results from their sources
  119. (cited inline). They're shared under fair-use for education; if you publish notes
  120. that closely track a copyrighted text, attribute clearly and prefer an original
  121. example. The mathematics belongs to its authors.
  122. Woven by **北极甜虾 (Polaris)**, 2026. Type by Libertinus, Optima, Avenir Next.
  123. Dyes after indigo, madder, weld, and iron-gall.
  124. <div align="center"><sub>If Loom makes a hard chapter feel like 砍瓜切菜 — star it. 🦐</sub></div>

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.