vndangkhoa/open-design
1
0
Fork 0
mirror of https://github.com/nexu-io/open-design.git synced 2026-06-01 03:14:35 +07:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
open-design/plugins/spec
History
pftom a0a3ad1299 feat(plugins): introduce portable plugin specification and authoring kit 
- Replaced the `community/` directory with `spec/`, which now serves as the portable plugin specification and authoring kit, including documentation, templates, and examples for contributors.
- Added new files for agent development, contributing guidelines, and a comprehensive README for the plugin spec kit.
- Updated existing documentation to reflect the new structure and clarify authoring rules for plugins.
- Introduced multiple example plugins under the new `spec/examples/` directory, showcasing various use cases and workflows for plugin authors.

This update enhances the clarity and accessibility of the plugin development process, providing a robust framework for contributors and external agents.
2026-05-13 21:24:36 +08:00
..
examples feat(plugins): introduce portable plugin specification and authoring kit 2026-05-13 21:24:36 +08:00
templates feat(plugins): introduce portable plugin specification and authoring kit 2026-05-13 21:24:36 +08:00
AGENT-DEVELOPMENT.md feat(plugins): introduce portable plugin specification and authoring kit 2026-05-13 21:24:36 +08:00
AGENT-DEVELOPMENT.zh-CN.md feat(plugins): introduce portable plugin specification and authoring kit 2026-05-13 21:24:36 +08:00
CONTRIBUTING.md feat(plugins): introduce portable plugin specification and authoring kit 2026-05-13 21:24:36 +08:00
CONTRIBUTING.zh-CN.md feat(plugins): introduce portable plugin specification and authoring kit 2026-05-13 21:24:36 +08:00
README.md feat(plugins): introduce portable plugin specification and authoring kit 2026-05-13 21:24:36 +08:00
README.zh-CN.md feat(plugins): introduce portable plugin specification and authoring kit 2026-05-13 21:24:36 +08:00
SPEC.md feat(plugins): introduce portable plugin specification and authoring kit 2026-05-13 21:24:36 +08:00
SPEC.zh-CN.md feat(plugins): introduce portable plugin specification and authoring kit 2026-05-13 21:24:36 +08:00

README.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.
  • templates/ - blank starter files.
  • examples/ - complete example plugin folders and a sample marketplace index.

Chinese mirrors:

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

  1. Copy templates/ to a new plugin folder.
  2. Rename the folder and frontmatter name to a lowercase id such as launch-deck.
  3. Write a pushy description in SKILL.md: "Use this plugin when..."
  4. Fill open-design.json: title, version, tags, od.taskKind, od.mode, od.useCase.query, od.pipeline, inputs, and capabilities.
  5. Add a small examples/ or preview/ artifact if the plugin is visual.
  6. 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: