SKILL.md

Use orz with an AI agent

Every orz tool ships an agent skill — a single SKILL.md that teaches an AI agent the syntax, conventions, and gotchas. Point your agent at it, describe what you want, and let it write the orz-flavoured Markdown.

You don’t have to learn the syntax. The skills exist so an agent can do the precise parts — layout grammar, page templates, plugin syntax — while you stay in plain language: “turn these notes into a 10-slide deck,” “lay this out as a two-column CV,” “add a QR code linking to the repo.” This page is just how to hand your agent the right skill.

The skills

orz-markdown render

The renderer itself: {{…}} plugins (mermaid, charts, KaTeX, QR…), ::: containers, themes, and page setup.

SKILL.md · GitHub

orz-mdhtml .md.html

Self-contained, editable HTML documents that read like a webpage and save in place.

SKILL.md · GitHub

orz-slides .slides.html

reveal.js decks: layout grammar, structure templates, regions, floats. See also the layouts reference.

SKILL.md · GitHub

orz-paged .paged.html

Paginated print/PDF documents: page templates, headers/footers, CVs, letters, exams, and a dynamic switch (e.g. exam answer keys). See also the documents reference.

SKILL.md · GitHub

Give your agent the skill

Any agent — point it at the URL

The simplest path. Paste the skill’s URL into your agent and ask it to follow it:

Read https://cdn.jsdelivr.net/npm/orz-slides/orz-slides-skills/SKILL.md
and use it to turn my notes below into a slide deck.

The URLs are stable (served from the published npm packages via jsDelivr) and always track the latest release.

Claude Code — drop in a skill folder

Copy the skill folder into your skills directory; Claude Code auto-discovers it on the next session.

# personal (all projects)        or   # this project only
~/.claude/skills/orz-slides/          .claude/skills/orz-slides/

If you’ve installed the package, the folder is already on disk — copy it from there:

cp -r node_modules/orz-slides/orz-slides-skills ~/.claude/skills/orz-slides

Claude.ai / Desktop — upload a skill

Download the skill folder (from the GitHub links above), zip it, and upload it under Settings → Capabilities → Skills. It’s then available in your chats.

Agents do the syntax; you do the intent. If you ever want the details yourself, every tool links its own reference — e.g. the slides layouts & syntax page.