0edbf38171
- Introduced `specVersion` and `version` fields to the plugin and marketplace schemas, ensuring better versioning and compatibility tracking. - Updated various components and functions to handle the new fields, including database migrations, plugin snapshots, and marketplace management. - Enhanced tests to validate the presence and correctness of the new fields in plugin manifests and marketplace entries. - Improved documentation to reflect the changes in schema requirements and provide guidance on the new versioning system. This update strengthens the plugin ecosystem by providing clear versioning, enhancing the reliability and maintainability of plugins and marketplaces. |
||
|---|---|---|
| .. | ||
| examples | ||
| templates | ||
| AGENT-DEVELOPMENT.md | ||
| AGENT-DEVELOPMENT.zh-CN.md | ||
| CONTRIBUTING.md | ||
| CONTRIBUTING.zh-CN.md | ||
| PUBLISHING-REGISTRIES.md | ||
| PUBLISHING-REGISTRIES.zh-CN.md | ||
| README.md | ||
| README.zh-CN.md | ||
| SPEC.md | ||
| SPEC.zh-CN.md | ||
Open Design Plugin Spec Kit
Language: English | 简体中文
This folder is the shareable specification kit for Open Design plugin authors. It is meant to work for a human reading the repo and for an external coding agent such as Claude Code, Codex, Cursor, OpenClaw, Hermes Agent, or another Agent Skills compatible tool.
Open Design plugins follow the same portable shape as Agent Skills: a folder with SKILL.md plus optional assets, references, scripts, and examples. Open Design adds open-design.json as a sidecar so the same folder can appear in the OD plugin gallery, hydrate the home composer, declare inputs and GenUI surfaces, run an OD atom pipeline, and participate in publish or PR flows.
Folder Map
SPEC.md- the portable plugin spec and taxonomy.AGENT-DEVELOPMENT.md- copy this into an external agent session to build and validate a plugin.CONTRIBUTING.md- PR standards for plugins that follow this spec.PUBLISHING-REGISTRIES.md- strategies for skills.sh, ClawHub, GitHub, and Open Design publishing.templates/- blank starter files.examples/- complete example plugin folders and a sample marketplace index.
Chinese mirrors:
SPEC.zh-CN.mdAGENT-DEVELOPMENT.zh-CN.mdCONTRIBUTING.zh-CN.mdPUBLISHING-REGISTRIES.zh-CN.mdexamples/README.zh-CN.md
What To Build
Workflow lanes:
- Import - Figma, GitHub, code folders, URLs, screenshots, PDFs, PPTX, Framer, Webflow.
- Create - prototypes, slide decks, live artifacts, image assets, video prompts, HyperFrames compositions, audio assets.
- Export - PPTX, PDF, HTML, ZIP, Markdown, Figma handoff, Next.js, React, Vue, Svelte, Astro, Angular, Tailwind.
- Share - public links, GitHub PRs, Gists, Slack, Discord, Notion, Linear, Jira.
- Deploy - Vercel, Cloudflare Pages, Netlify, GitHub Pages, Fly.io, Render.
- Refine - critique, patch, tune, brand swap, A/B variants, stakeholder review.
- Extend - plugin authoring, marketplace publishing, internal catalog automation.
Five Minute Start
- Copy
templates/to a new plugin folder. - Rename the folder and frontmatter
nameto a lowercase id such aslaunch-deck. - Write a pushy
descriptioninSKILL.md: "Use this plugin when..." - Fill
open-design.json:specVersion, title, pluginversion, tags,od.taskKind,od.mode,od.useCase.query,od.pipeline, inputs, and capabilities. - Add a small
examples/orpreview/artifact if the plugin is visual. - Validate locally:
pnpm guard
pnpm --filter @open-design/plugin-runtime typecheck
When the daemon CLI is built:
od plugin validate ./path/to/plugin
od plugin install ./path/to/plugin
od plugin apply <plugin-id> --input key=value
Compatibility Promise
A folder with SKILL.md can be used as a plain skill in Agent Skills compatible clients. Adding open-design.json should never make the skill less portable; it only adds Open Design product behavior.
References:
- Agent Skills overview: https://agentskills.io/home
- Agent Skills specification: https://agentskills.io/specification
- Open Design plugin spec: ../../docs/plugins-spec.md