Skip to content

README.md

Latest commit

 

History

History
60 lines (42 loc) · 2.52 KB

README.md

File metadata and controls

60 lines (42 loc) · 2.52 KB
Raw

Astro Plugin for Codex

A Codex-native Astro plugin that packages Astro documentation access, reusable workflow skills, and project best practices for day-to-day Astro development.

Features

Astro Docs MCP

Connects Codex to the official Astro Docs MCP server so documentation lookup stays inside your workflow.

Skills

Skill Description
astro-best-practices Applies performant, accessible, and maintainable Astro conventions while planning, writing, or reviewing code
docs-lookup Searches and summarizes Astro documentation using the configured Astro Docs MCP server
create-component Scaffolds Astro components, pages, and layouts with typed props and accessibility checks
content-collection Guides content collection setup with type-safe schemas and query patterns
add-integration Helps add official or community Astro integrations and the required follow-up config
migrate Guides migrations from other frameworks or between Astro versions

Install In Codex

This repository is already wired as a repo-scoped Codex marketplace. The marketplace entry lives at .agents/plugins/marketplace.json and points to the current repo root with source.path: "./".

  1. Open /Users/markteekman/Incluud/astro-codex-plugin in Codex.
  2. Restart Codex so it reloads local marketplace files.
  3. Open the Plugin Directory.
  4. Choose the Incluud Plugins marketplace.
  5. Install and enable Astro.

After you change the plugin, restart Codex again so the local install refreshes from the updated repo contents.

Plugin Structure

astro-codex-plugin/
├── .codex-plugin/plugin.json
├── .mcp.json
├── .agents/plugins/marketplace.json
├── assets/
└── skills/

Example Prompts

  • Look up the Astro docs for content collections and explain the setup
  • Create an accessible Astro card component with slots and typed props
  • Add the Netlify adapter to this Astro project and explain the required config
  • Migrate this page from Next.js to Astro with minimal client-side JavaScript

Notes

  • Project best practices are packaged as a Codex skill instead of an always-on rule file.
  • The Astro Docs MCP server is configured in .mcp.json.
  • Visual install assets live in assets/.

License

MIT