OpenParable
Skip to content
← Back to skills

Zditor Syntax

Documents
zditor-syntax

Zditor Syntax is an Agent Skill for documents published in the zditor/zditor-docs repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Use when users ask to learn Zditor extended Markdown syntax, fix invalid Zditor markdown, or generate content that must follow Zditor syntax rules. Read references/zditor-syntax.md for the syntax catalog and examples.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/zditor/zditor-docs/blob/HEAD/skills/zditor-syntax/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/zditor-syntax, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Zditor Syntax

Use this skill for Zditor-specific markdown tasks rather than generic Markdown help.

Workflow

  1. Read references/zditor-syntax.md before answering or generating content.
  2. If the user wants an explanation, answer briefly and include a minimal valid example.
  3. If the user wants content generation, return valid Zditor markdown directly.
  4. Prefer the smallest syntax that satisfies the request.
  5. If the user provides broken syntax, fix it and briefly note the key correction.
  6. Distinguish raw Markdown from toolbar editing: when generating raw source, encode spaces inside () as %20 for link-like Zditor syntax; when explaining toolbar workflows, note that toolbar inputs can use normal spaces and the serializer will encode them on save.

Guardrails

  • Keep indentation, fences, and delimiters exact.
  • Do not invent unsupported syntax. Check the reference when unsure.
  • Do not tell users to manually type %20 into toolbar input fields for link / tip / revision if the issue is about editor-side input.