The ggtypst repository includes a reusable AI skill
located at ggtypst-skill/SKILL.md. This skill is a
lightweight instruction file that helps an AI coding tool answer
questions about the package and generate correct ggtypst
examples.
What it is
The skill is a package-specific guide for AI tools, designed to help
users get more accurate assistance when working with
ggtypst.
Instead of starting from a blank prompt, an AI assistant can load
this skill and immediately understand the main usage patterns of
ggtypst. It helps the assistant:
- recommend the right function for a plotting task
- write package-aware plot code
- explain installation and raw-string usage correctly
- describe common pitfalls such as
size.unit,inline, and math face limits
What it contains
The current skill file contains:
- a short description to help AI tools recognize the skill
- a quick mental model of how
ggtypstworks - guidance for installation and package setup
- examples for
annotate_*(),geom_*(), andelement_*() - notes on Typst strings, MiTeX conversion, and parameter conventions
- raw strings, common parameters, and troubleshooting patterns
How to import it
You can import the skill with npx skills. Run the
command in your terminal:
npx skills
will find the ggtypst skill and add the skill to your AI
tools automatically, such as Claude Code, Codex, GitHub Copilot, OpenCode or others.
After that, your AI tools should be able to load the
ggtypst skill and use it as package-specific context when
answering questions or generating code.
