# Subframe Docs - [Introduction](https://docs.subframe.com/overview.md): Design and build web software in one place with a canvas, browser, and coding agent. - [Quickstart](https://docs.subframe.com/quickstart.md): Install Subframe, connect your codebase, and ship your first change. - [Desktop app](https://docs.subframe.com/desktop-app.md): Work with your local codebase, development server, and coding agent in Subframe. - [FAQ](https://docs.subframe.com/faq.md): Answers to common questions about Subframe. - [Overview](https://docs.subframe.com/design/overview.md): Learn the Subframe editor interface and navigate between editing modes. - [Elements](https://docs.subframe.com/design/elements.md): The building blocks of all designs. - [Overview](https://docs.subframe.com/design/components/overview.md): Reusable UI building blocks for your designs. - [Subcomponents](https://docs.subframe.com/design/components/subcomponents.md): Child components scoped to a parent component. - [Props & slots](https://docs.subframe.com/design/components/props-and-slots.md): Add data and composition to your components. - [Variants](https://docs.subframe.com/design/components/variants.md): Create different visual styles for your component. - [Hover, active, focus states](https://docs.subframe.com/design/components/states.md): Add interaction states to your components. - [Import existing design system](https://docs.subframe.com/design/components/importing.md): Bring your theme, components, and icons from code into Subframe. - [Pages](https://docs.subframe.com/design/pages.md): Design individual pages in your project. - [Customizing theme](https://docs.subframe.com/design/theme/customizing-theme.md): Define design tokens for colors, typography, borders, corners, and shadows. - [Importing tokens](https://docs.subframe.com/design/theme/importing-tokens.md): Import design tokens from Tailwind config, CSS, or JSON files to set up your theme. - [Exporting theme](https://docs.subframe.com/design/theme/exporting-theme.md): View your generated Tailwind config and sync theme changes to your codebase. - [Adding custom fonts](https://docs.subframe.com/design/theme/adding-custom-fonts.md): Upload custom font files to use in your theme. - [Canvases](https://docs.subframe.com/design/canvases.md): Organize related pages on a canvas. - [Snippets](https://docs.subframe.com/design/snippets.md): Save and reuse design patterns. - [Writing design docs](https://docs.subframe.com/design/documents.md): Use design documents to share product context, brand voice, and component guidelines with your team and AI agents. - [Overview](https://docs.subframe.com/design/projects/overview.md): Create, manage, and organize projects for your team. - [Project settings](https://docs.subframe.com/design/projects/project-settings.md): Configure the import alias and icon imports for exported code. - [Version history](https://docs.subframe.com/design/projects/version-history.md): View and restore previous versions. - [Layers](https://docs.subframe.com/design/design-mode/layers.md): Navigate and organize the element hierarchy. - [Inspector](https://docs.subframe.com/design/design-mode/inspector.md): Configure element properties in the right sidebar. - [Adding elements](https://docs.subframe.com/design/design-mode/adding-elements.md): Add elements to your design using quick insert or drag-and-drop. - [Working with stacks](https://docs.subframe.com/design/design-mode/working-with-stacks.md): Master stack-based layouts with direction, spacing, and alignment. - [Page layouts](https://docs.subframe.com/design/design-mode/page-layouts.md): Apply reusable navigation and modal layouts to your pages. - [Previewing designs](https://docs.subframe.com/design/design-mode/preview.md): Preview your designs and test interactions. - [Responsive design](https://docs.subframe.com/design/design-mode/responsive-design.md): Design across custom breakpoints for every screen size. - [Quick actions](https://docs.subframe.com/design/design-mode/quick-actions.md): Set properties and take actions on elements. - [Keyboard shortcuts](https://docs.subframe.com/design/design-mode/keyboard-shortcuts.md): Speed up your workflow with keyboard shortcuts. - [Comments](https://docs.subframe.com/design/design-mode/comments.md): Leave feedback and collaborate on your designs. - [Share designs](https://docs.subframe.com/design/design-mode/share-designs.md): Let your teammates and external stakeholders view your designs. - [Custom CSS](https://docs.subframe.com/design/design-mode/custom-css.md): Add custom Tailwind classes as an escape hatch for CSS properties not available in the Inspector. - [Generating designs](https://docs.subframe.com/design/ask-ai/prompt-to-design.md): Generate AI designs in Agent chat, edit pages and components, and update your Subframe theme. - [Quick edits](https://docs.subframe.com/design/ask-ai/making-quick-edits.md): Ask the agent in context to edit or insert specific elements. - [Image to design](https://docs.subframe.com/design/ask-ai/image-to-design.md): Turn screenshots, Figma exports, and web pages into designs with Subframe’s AI agent. - [Adding context with @](https://docs.subframe.com/design/ask-ai/adding-context.md): Type @ to reference pages, components, and snippets in your prompt. - [Exporting code and images](https://docs.subframe.com/design/code-mode/overview.md): View and export code and images from your designs. - [Creating prototypes](https://docs.subframe.com/design/prototype-mode/overview.md): Create interactive prototypes with AI-powered code generation. - [Annotations](https://docs.subframe.com/design/prototype-mode/annotations.md): Add implementation notes to guide AI prototype generation. - [Interactions](https://docs.subframe.com/design/prototype-mode/click-through-prototypes.md): Create clickable prototypes in preview mode. - [Overview](https://docs.subframe.com/browser/overview.md): Open your local app or any website inside Subframe. - [Previewing your local app](https://docs.subframe.com/browser/previewing-your-local-app.md): See your running app inside Subframe. - [Making live edits](https://docs.subframe.com/browser/making-live-edits.md): Edit or comment on your running app, then send the changes to your agent. - [Capturing as designs](https://docs.subframe.com/browser/capturing-as-designs.md): Capture a page or element from the browser as an editable design. - [Troubleshooting](https://docs.subframe.com/browser/troubleshooting.md): Fix common issues with the built-in browser. - [Using Agent chat](https://docs.subframe.com/agent/overview.md): Work with an AI coding agent across your designs, browser, and codebase in Subframe. - [Connecting an agent](https://docs.subframe.com/agent/connecting-an-agent.md): Use Subframe AI credits or connect your Claude Code or Codex subscription. - [MCP server](https://docs.subframe.com/agent/mcp-server.md): Connect AI coding agents in Claude Code, Cursor, and Codex to Subframe with the MCP server. - [Connecting your codebase](https://docs.subframe.com/agent/connecting-your-codebase.md): Give the agent access to read, edit, and run your local project. - [Giving your agent context](https://docs.subframe.com/agent/giving-your-agent-context.md): Point the agent to the designs, browser pages, project content, images, and files it needs. - [Making code changes](https://docs.subframe.com/agent/making-code-changes.md): Ask the agent to implement work in your connected codebase and review the result. - [Managing chats](https://docs.subframe.com/agent/managing-chats.md): Start, revisit, and track agent work across your project. - [Troubleshooting](https://docs.subframe.com/agent/troubleshooting.md): Fix common agent, model, chat, and codebase connection problems. - [Starting your design system in Subframe](https://docs.subframe.com/develop/overview.md): Build and manage your design system visually in Subframe, then sync it to code. - [Installation](https://docs.subframe.com/develop/installation.md): Set up Subframe in your codebase. - [Design to code workflow](https://docs.subframe.com/develop/concepts/design-to-code.md): How Subframe connects designs to your codebase. - [Code generation](https://docs.subframe.com/develop/concepts/code-generation.md): How Subframe generates clean, production-ready React code. - [Syncing components](https://docs.subframe.com/develop/concepts/syncing-components.md): Keep your design system in sync between Subframe and your codebase. - [Dark mode](https://docs.subframe.com/develop/guides/dark-mode.md): Add dark mode to your project using Subframe's built-in theme support - [Accessibility](https://docs.subframe.com/develop/guides/accessibility.md): Build accessible interfaces with Subframe components. - [Testing](https://docs.subframe.com/develop/guides/testing.md): Add test attributes to Subframe components. - [CLI in CI & agents](https://docs.subframe.com/develop/guides/cli-automation.md): Run the Subframe CLI non-interactively from CI pipelines and AI coding agents. - [Publishing to NPM](https://docs.subframe.com/develop/guides/publish-to-npm.md): Distribute components as a package. - [Component directories](https://docs.subframe.com/develop/upgrading/component-directories.md): Subframe now syncs each component as a directory. What changed, why, and how to migrate. - [Next.js](https://docs.subframe.com/develop/frameworks/nextjs.md): Install Subframe in Next.js projects. - [Vite](https://docs.subframe.com/develop/frameworks/vite.md): Install Subframe in Vite projects. - [Astro](https://docs.subframe.com/develop/frameworks/astro.md): Install Subframe in Astro projects. - [Monorepo](https://docs.subframe.com/develop/frameworks/monorepo.md): Set up Subframe in a monorepo to share components across multiple apps. - [Manual installation](https://docs.subframe.com/develop/frameworks/manual.md): Step-by-step guide to manually install Subframe without the CLI. - [Managing team members](https://docs.subframe.com/admin/managing-team.md): Invite collaborators and manage roles for your team. - [Managing pricing and plans](https://docs.subframe.com/admin/pricing-and-plans.md): Compare plans, understand Subframe AI credits, and manage your subscription. - [Managing auth tokens](https://docs.subframe.com/admin/auth-tokens.md): Create and delete auth tokens for the Subframe CLI. - [Setting up Okta SSO](https://docs.subframe.com/admin/sso/okta.md): Configure Okta single sign-on for your Subframe team. ## OpenAPI Specs - [package](/package.json) ## Optional - [Go to Subframe](https://subframe.com?utm_source=mintlify&utm_medium=docs&utm_campaign=global_link) - [Slack Community](https://join.slack.com/t/subframecommunity/shared_invite/zt-380uma6dv-_lr7_bDLU5DJcoygfUYkeQ) - [YouTube](https://www.youtube.com/@SubframeApp) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.