Skip to content
Back to search

opentikz

TikZ for paper diagrams, without hand-writing TikZ — copyable icons, editable templates, and a Claude Code skill

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/opentikz--opentikz/badge.svg)](/listings/opentikz--opentikz)

HTML

<a href="/listings/opentikz--opentikz"><img src="/api/listings/opentikz--opentikz/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.

**Use it with your AI agent (recommended).** Install the Claude Code plugin — run these as two separate Claude Code messages:

/plugin marketplace add https://github.com/opentikz/opentikz
/plugin install opentikz@opentikz

Then describe the figure or edit you want - *"draw an encoder–decoder with a cross-attention block,"* or, - pointing at a template, *"add a hidden layer / recolor this blue / fit it to a CVPR column."* The skill finds the figure, copies it into your project, edits it via each template's `edit_contract`, and compiles it before handing it back. Invoke it as `/opentikz:using-opentikz`.

**Other agents (Codex, Cursor, Gemini CLI…).** `git clone` this repo and tell the agent to use `skills/using-opentikz/SKILL.md`, or just point a GitHub-reading agent at the repo URL.

**Prefer no AI?** [Browse the gallery](#gallery), copy a figure's `.tex`, and paste it in — every file is `\documentclass{standalone}` and compiles as-is.

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.

.claude-plugin/marketplace.json · Manifest · 12 lines

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

  1. {
  2. "name": "opentikz",
  3. "owner": { "name": "OpenTikZ contributors" },
  4. "description": "TikZ resources for academic conceptual diagrams.",
  5. "plugins": [
  6. {
  7. "name": "opentikz",
  8. "source": "./",
  9. "description": "Find, edit, and verify academic TikZ figures (icons, templates, examples) with the using-opentikz skill."
  10. }
  11. ]
  12. }
README.md · README · 241 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. <a href="https://opentikz.org"><img src="assets/opentikz-logo.svg" alt="OpenTikZ" width="440"></a>
  3. ### Describe your figure. Get it, paper-ready.
  4. More than an AI-agent skill for LaTeX TikZ figures.
  5. [![Star OpenTikZ on GitHub](https://img.shields.io/github/stars/opentikz/opentikz?style=flat&label=%E2%98%85%20Star&color=E69F00)](https://github.com/opentikz/opentikz)
  6. [![CI](https://github.com/opentikz/opentikz/actions/workflows/ci.yml/badge.svg)](https://github.com/opentikz/opentikz/actions/workflows/ci.yml)
  7. [![Deploy site](https://github.com/opentikz/opentikz/actions/workflows/pages.yml/badge.svg)](https://github.com/opentikz/opentikz/actions/workflows/pages.yml)
  8. [![Website](https://img.shields.io/badge/website-opentikz.org-0072B2)](https://opentikz.org)
  9. [![Code: MIT](https://img.shields.io/badge/code-MIT-1B1A16)](LICENSE-CODE)
  10. [![Content: CC0 1.0](https://img.shields.io/badge/content-CC0%201.0-E69F00)](LICENSE-CONTENT)
  11. **[Website](https://opentikz.org)** · [Browse](https://opentikz.org/browse/) · [Templates](templates/) · [Icons](icons/) · [Examples](examples/) · [Quick start](#quick-start) · [Contributing](CONTRIBUTING.md)
  12. </div>
  13. ---
  14. OpenTikZ is the "Flaticon for academic TikZ" — conceptual/overview figures
  15. (system block diagrams, neural-network architectures, pipelines, flowcharts) for
  16. your papers, made fast. Four ways to use it:
  17. - **Use icons** — grab a single icon, no AI needed: copy its `.tex` (or download SVG/PNG) and `\input` it.
  18. - **Edit a template** — tell the agent the change; it edits the template and verifies it compiles.
  19. - **PNG → TikZ** — hand the agent a figure image; get editable TikZ back.
  20. - **Describe → TikZ** — describe a figure in words; the agent drafts it from the library.
  21. ## Quick start
  22. **Use it with your AI agent (recommended).** Install the Claude Code plugin —
  23. run these as two separate Claude Code messages:
  24. ```text
  25. /plugin marketplace add https://github.com/opentikz/opentikz
  26. /plugin install opentikz@opentikz
  27. ```
  28. Then describe the figure or edit you want
  29. - *"draw an encoder–decoder with a cross-attention block,"* or,
  30. - pointing at a template, *"add a hidden layer / recolor this blue / fit it to a CVPR column."*
  31. The skill finds the figure, copies it into your project, edits it via each template's `edit_contract`, and compiles it before
  32. handing it back. Invoke it as `/opentikz:using-opentikz`.
  33. **Other agents (Codex, Cursor, Gemini CLI…).** `git clone` this repo and tell the
  34. agent to use `skills/using-opentikz/SKILL.md`, or just point a GitHub-reading agent
  35. at the repo URL.
  36. **Prefer no AI?** [Browse the gallery](#gallery), copy a figure's `.tex`, and paste
  37. it in — every file is `\documentclass{standalone}` and compiles as-is.
  38. ## Why TikZ, and why OpenTikZ
  39. **Why TikZ at all?** A TikZ figure is *source code*, not an image:
  40. - **Vector quality** — crisp at any zoom, sharp in print; no pixelated screenshots.
  41. - **Native to your paper** — same fonts, math (`$\mathbf{W}x$`), and
  42. `\ref`/`\cite` as the document, so the figure looks part of the paper.
  43. - **Diffable** — version it in git, tweak one number, recompile.
  44. **Why not just ask ChatGPT for TikZ directly?** You can — but raw LLM TikZ tends
  45. to fight you. OpenTikZ anchors the edit to a real, parametric template:
  46. | What you care about | Raw LLM TikZ | OpenTikZ + skill |
  47. | --- | --- | --- |
  48. | Compiles first try | Often not | Yes, standalone |
  49. | Packages / macros | Sometimes invented | Real, declared in `requires` |
  50. | Colors | Random hex | Shared palette |
  51. | Re-editing later | Re-describe everything | Stable node names |
  52. | AI guidance | None | Each template ships an `edit_contract` |
  53. Because every template is parametric, palette-correct, and carries an
  54. `edit_contract`, an agent edits it **accurately** and **fast** instead of
  55. hand-writing TikZ that may not compile.
  56. ### A concrete edit
  57. Starting from [`templates/encoder-decoder/`](templates/encoder-decoder/), tell
  58. Claude Code:
  59. > *"add a cross-attention block and make it blue"*
  60. Guided by the template's `edit_contract` — using the shared palette and the
  61. template's stable node names — it adds:
  62. ```tex
  63. % cross-attention block (decoder attends to encoder)
  64. \node[draw=otblue!80!black, fill=otblue!18, rounded corners=2pt,
  65. minimum width=\trapW cm, minimum height=0.7cm]
  66. (xattn) at (\xdC,\bh+0.9) {\sffamily\small Cross-Attn};
  67. \draw[flow, draw=otblue] (enc) to[bend left=20] (xattn);
  68. \draw[flow, draw=otblue] (xattn) -- (dec);
  69. ```
  70. …and it compiles standalone, first try.
  71. ## Gallery
  72. A taste of the library below — every preview is rendered from the committed `.tex`
  73. source (no mockups). **The full, searchable catalog with copy-to-clipboard lives on
  74. the [website](https://opentikz.org)**; or browse [`examples/`](examples/),
  75. [`templates/`](templates/), and [`icons/`](icons/) directly.
  76. ### Examples — paper-grade figures combining icons + templates
  77. <table>
  78. <tr>
  79. <td align="center" width="33%"><a href="examples/lora/"><img src="examples/lora/preview.svg" alt="LoRA (low-rank adaptation)" width="260"></a><br><sub><b>LoRA</b> · low-rank adaptation</sub></td>
  80. <td align="center" width="33%"><a href="examples/flash-attention/"><img src="examples/flash-attention/preview.svg" alt="FlashAttention" width="260"></a><br><sub><b>FlashAttention</b> · tiled attention</sub></td>
  81. <td align="center" width="33%"><a href="examples/gan/"><img src="examples/gan/preview.svg" alt="Generative adversarial network" width="260"></a><br><sub><b>GAN</b> · generator / discriminator</sub></td>
  82. </tr>
  83. </table>
  84. ### Templates — editable, AI-modifiable (each ships an `edit_contract`)
  85. <table>
  86. <tr>
  87. <td align="center" width="33%"><a href="templates/neural-net/"><img src="templates/neural-net/preview.svg" alt="Feed-forward neural network" width="240"></a><br><sub><b>Feed-forward</b> neural network</sub></td>
  88. <td align="center" width="33%"><a href="templates/encoder-decoder/"><img src="templates/encoder-decoder/preview.svg" alt="Encoder-decoder (bottleneck)" width="240"></a><br><sub><b>Encoder-decoder</b> · bottleneck</sub></td>
  89. <td align="center" width="33%"><a href="templates/llm-serving-stack/"><img src="templates/llm-serving-stack/preview.svg" alt="LLM serving stack" width="240"></a><br><sub><b>LLM serving stack</b> · brand-logo cards</sub></td>
  90. </tr>
  91. </table>
  92. <sub>…and more — system block diagrams, flowcharts, ResNet blocks, distributed
  93. training, inference serving. See [`templates/`](templates/).</sub>
  94. ### Icons — atomic, single-concept, independently copyable
  95. <table>
  96. <tr>
  97. <td align="center" width="20%"><a href="icons/systems/server/"><img src="icons/systems/server/server.svg" alt="Server" width="84"></a><br><sub>Server</sub></td>
  98. <td align="center" width="20%"><a href="icons/systems/gpu/"><img src="icons/systems/gpu/gpu.svg" alt="GPU" width="84"></a><br><sub>GPU</sub></td>
  99. <td align="center" width="20%"><a href="icons/systems/cloud/"><img src="icons/systems/cloud/cloud.svg" alt="Cloud" width="84"></a><br><sub>Cloud</sub></td>
  100. <td align="center" width="20%"><a href="icons/ml/neuron/"><img src="icons/ml/neuron/neuron.svg" alt="Neuron" width="84"></a><br><sub>Neuron</sub></td>
  101. <td align="center" width="20%"><a href="icons/ml/attention/"><img src="icons/ml/attention/attention.svg" alt="Attention block" width="84"></a><br><sub>Attention</sub></td>
  102. </tr>
  103. <tr>
  104. <td align="center" width="20%"><a href="icons/brands/pytorch/"><img src="icons/brands/pytorch/pytorch.svg" alt="PyTorch" width="84"></a><br><sub>PyTorch</sub></td>
  105. <td align="center" width="20%"><a href="icons/brands/huggingface/"><img src="icons/brands/huggingface/huggingface.svg" alt="Hugging Face" width="84"></a><br><sub>Hugging Face</sub></td>
  106. <td align="center" width="20%"><a href="icons/brands/arxiv/"><img src="icons/brands/arxiv/arxiv.svg" alt="arXiv" width="84"></a><br><sub>arXiv</sub></td>
  107. <td align="center" width="20%"><a href="icons/brands/claude/"><img src="icons/brands/claude/claude.svg" alt="Claude" width="84"></a><br><sub>Claude</sub></td>
  108. <td align="center" width="20%"><a href="icons/brands/docker/"><img src="icons/brands/docker/docker.svg" alt="Docker" width="84"></a><br><sub>Docker</sub></td>
  109. </tr>
  110. </table>
  111. <sub>…and many more across <code>systems/</code>, <code>ml/</code>, and
  112. <code>brands/</code> (41 tool/platform logos — trademark notes in
  113. <a href="icons/brands/README.md"><code>icons/brands/README.md</code></a>). Previews are
  114. transparent SVGs and read best on a light background; the live
  115. [website](https://opentikz.org) renders them on paper-white tiles.</sub>
  116. ## How it's organized
  117. Three layers, plus the skill that ties them together:
  118. - **`icons/`** — atomic, single-concept TikZ elements; each compiles standalone
  119. and is independently copyable.
  120. - **`templates/`** — complete, editable conceptual figures (the core value); each
  121. carries an `edit_contract` in its `meta.json` describing how to edit it safely.
  122. - **`examples/`** — paper-grade figures combining icons + templates.
  123. - **`skills/using-opentikz/`** — the one repo-wide skill that takes an AI agent
  124. from a request to a finished figure (discover → edit → verify), backed by the
  125. per-template `edit_contract`s and the `reference/` palette/layout material.
  126. ```
  127. icons/<domain>/<name>/ <name>.tex + <name>.meta.json + <name>.svg
  128. templates/<name>/ template.tex + template.meta.json (+ edit_contract) + preview.svg
  129. examples/<name>/ paper-grade figures combining icons + templates
  130. skills/using-opentikz/ the one repo-wide skill (SKILL.md)
  131. reference/ color-palettes/, annotations/, layout/
  132. tools/ build_catalog.py, render_preview.py, build_site.py, validate.py
  133. ```
  134. ## Community
  135. - 💬 **[Discussions](https://github.com/opentikz/opentikz/discussions)** — ask how
  136. to use a template or the skill (Q&A), request a new icon/template (Ideas), or
  137. show a figure you built (Show & tell).
  138. - 🐛 **[Issues](https://github.com/opentikz/opentikz/issues)** — report a bug or a
  139. figure that won't compile, or file a concrete task.
  140. Rule of thumb: open-ended → Discussions, closeable → Issues.
  141. ## Contributing & local build
  142. Want to add a figure or fix one? See [`CONTRIBUTING.md`](CONTRIBUTING.md) for the
  143. format rules and [`docs/DESIGN_GUIDE.md`](docs/DESIGN_GUIDE.md) for the design
  144. guide. The toolchain (all stdlib + an optional LaTeX backend):
  145. ```bash
  146. python3 -m pip install -r requirements.txt # installs jsonschema
  147. python3 tools/validate.py # validate metadata + compile .tex
  148. python3 tools/build_catalog.py # regenerate catalog.json (never hand-edit it)
  149. python3 tools/render_preview.py <item> # render a trimmed .svg preview
  150. python3 tools/build_site.py # build the static site/ locally
  151. ```
  152. `validate.py` and `render_preview.py` need a LaTeX toolchain (`latexmk`) plus an
  153. SVG backend (`dvisvgm`, or `pdf2svg` + `pdfcrop`); without LaTeX, `validate.py`
  154. still checks metadata and skips the compile. The site ([opentikz.org](https://opentikz.org))
  155. deploys automatically from `catalog.json` + committed previews on every push to
  156. `main` via [`.github/workflows/pages.yml`](.github/workflows/pages.yml).
  157. ## Citing OpenTikZ
  158. Content is CC0, so a citation is never required — but if OpenTikZ saved you time,
  159. it is appreciated. Use the **"Cite this repository"** button on GitHub (powered by
  160. [`CITATION.cff`](CITATION.cff)), or the BibTeX below:
  161. ```bibtex
  162. @misc{opentikz,
  163. title = {{OpenTikZ}: a TikZ resource library for academic conceptual diagrams},
  164. author = {{OpenTikZ contributors}},
  165. year = {2026},
  166. howpublished = {\url{https://opentikz.org}},
  167. note = {Content licensed CC0 1.0}
  168. }
  169. ```
  170. ## Licensing
  171. - **Code** (scripts, build tooling): MIT — see [`LICENSE-CODE`](LICENSE-CODE).
  172. - **Graphic content** (`.tex` figures and previews): CC0 1.0 — see
  173. [`LICENSE-CONTENT`](LICENSE-CONTENT).
  174. By contributing graphic content you agree to release it under CC0 1.0.
  175. ---
  176. <div align="center">
  177. ### ⭐ Found OpenTikZ useful?
  178. [**Star us on GitHub**](https://github.com/opentikz/opentikz) — it helps more researchers
  179. discover the library and find these figures faster.
  180. [![Star OpenTikZ on GitHub](https://img.shields.io/github/stars/opentikz/opentikz?style=social)](https://github.com/opentikz/opentikz)
  181. </div>

Ratings and comments

Sign in to rate this skill.

Sign in

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