Installation
Get started with fromsrc
Create a new project
The fastest way to start is with create-fromsrc:
Run the command
This creates a new directory with everything configured.
For non-interactive setup:
List available framework values:
Start the dev server
For log tail and controlled restart:
Manual installation
Add fromsrc to an existing app:
For framework-specific walkthroughs, use the manual guides:
Next.js adapter
Use the Next.js adapter entry for framework wiring:
React Router adapter
Use the React Router adapter for browser-router apps:
Vite adapter
Use the Vite adapter for custom router stacks:
TanStack adapter
Use the TanStack adapter for TanStack Router apps:
Remix adapter
Use the Remix adapter for Remix routes and navigation:
Astro adapter
Use the Astro adapter for Astro integrations with client-rendered docs surfaces:
Project structure
Troubleshooting
Ensure fromsrc is installed:
Verify the subpath import matches your framework:
Run the tree-shake regression check:
This validates root, utility, and adapter imports stay inside budget.
Search indexes content from your docs folder. Ensure you have .mdx files
with valid frontmatter: yaml --- title: page title description: page description ---
Import the fromsrc styles in your root layout or globals.css. Check that Tailwind is configured correctly.
Verify your catch-all route is at app/docs/[[...slug]]/page.tsx and
imports from fromsrc correctly.
Restart and inspect logs: