Skip to content
Portfolio Kit

AI & agents

Markdown versions of every page, llms.txt, the shadcn MCP server and rules to paste into your AGENTS.md.

Guides, individual component and template pages, and the theme reference are available as plain Markdown. Coding agents can read them and install source through the shadcn registry.

Markdown for every page

Add .md to an individual guide, component or template URL to read its Markdown. The introduction at /docs uses /docs/introduction.md; component and template catalog pages are indexed by /llms.txt.

URLContents
/AGENTS.mdIntegration instructions: inspect the consumer, install, preserve accessibility and verify.
/agent.mdCompact product scope and availability summary.
/llms.txtIndex of every guide, template and component, one line each (llmstxt.org format).
/llms-full.txtAll guides and component docs in one file.
/components/<name>.mdOne component: install, usage, examples, API.
/templates/<name>.mdOne template: install, the components it uses, source.
/r/<name>.jsonThe shadcn registry item (source files + dependencies).

Every page also has a Copy page button that copies its Markdown for pasting into a chat.

shadcn MCP server

The shadcn MCP server lets agents browse, search and install from any registry in your components.json. After adding the registry:

npx shadcn@latest mcp init --client claude

Other clients: cursor, vscode, codex. Then ask things like "Add a hero, a project grid and a contact section from @portfolio-kit".

Rules for AGENTS.md

Paste this into your project's AGENTS.md (or CLAUDE.md, .cursor/rules) so your agent uses the kit correctly:

## Portfolio Kit

UI for this portfolio comes from Portfolio Kit (shadcn registry `@portfolio-kit`).
- Catalog: https://www.parthjadhav.com/products/portfolio-kit/llms.txt. Read a component's docs at https://www.parthjadhav.com/products/portfolio-kit/components/<name>.md before using it.
- Install with `npx shadcn@latest add @portfolio-kit/<name>`. Files land in components/portfolio/.
- Prefer composing kit components over writing new ones. Use compound parts; restyle with className.
- Colors: semantic tokens only (bg-background, text-muted-foreground, bg-highlight, text-highlight-ink,
  border-border-hover). Never hard-code colors. Headings use font-heading; never add font-bold to them.
- Wrap page sections in <Section> (from section.tsx). Cards: rounded-2xl border bg-card shadow-card p-5 md:p-6.
- Type: use the recipes in lib/typography (typography.title, .eyebrow for small mono labels, .meta for dates).
- Motion: ease-smooth, behind motion-safe:/motion-reduce:. Content must never stay hidden (no JS, reduced motion, print).
- Keep everything accessible: real links/buttons, alt text, aria-label on icon-only buttons.

Example prompts

For contributors

The repository and product AGENTS.md files describe maintenance boundaries. Run checks from website/ with Bun:

bun test tests/portfolio-kit-agent-resources.test.mjs tests/portfolio-kit-release.test.mjs
bun run verify flows portfolio-kit-theme portfolio-kit-docs --origin http://localhost:3481

Start that local server with bun dev -p 3481 (Portfolio Kit is on by default; DISABLE_PORTFOLIO_KIT=1 turns it off). The parent website's bun run verify check runs its full release gate, including the production checks that Portfolio Kit's routes, registry and resources are served. The standalone upstream project's pnpm scripts are not commands for this native migration.