typedown-expert
Installation
SKILL.md
Typedown Expert
This skill provides expert knowledge for writing Typedown files (.td). Typedown is a Consensus Modeling Language that embeds Pydantic models and Pytest logic into Markdown.
Core Syntax Rules
-
File Structure:
- Typedown files are valid Markdown files.
- They consist of natural language text interleaved with special Code Blocks.
- Crucial: Every
.tdfile MUST start with a Level 1 Heading (# Title) and a brief textual description. Never start with a code block.
-
Model Blocks (
model:<Name>):- Used to define Pydantic models.
- One Model Per Block: Do NOT define multiple classes in a single block. Each class gets its own
model:ClassNameblock. - No Imports in Block: Do NOT import
typingorpydanticinside the block unless it's a specific, non-standard import. The environment pre-loads standard types. - Class Name Match: The class defined MUST match the block argument (e.g.,
class Userinside```model:User).