Quickstart
-
Create your site.
Terminal window npm create astro@latest -- --template ekline-io/potluck-docs/packages/template --no-aiYou’ll be asked where to create the project — type a directory name (for example
my-docs) and press Enter — then say yes to installing dependencies and initializing git (it’ll flag the template as “third-party” first; expected, since this isn’t one of Astro’s own starters).Keep
--no-ai. Without it,create-astroadds a genericAGENTS.mdpointing coding assistants at general Astro documentation, which contradicts the Starlight rules the template ships inCLAUDE.md. One more thing to know: whatever you name the directory becomes thenamein yourpackage.json, so change it later if that isn’t what you want. -
Start the dev server.
Terminal window cd my-docsnpm run devYour site is live at
localhost:4321with hot reload. -
Make your first edit.
Open
src/content/docs/index.mdxand change thetaglineunderhero:hero:tagline: This is your new documentation site. Tailwind, sitemap, and llms.txt are already wired up — replace this welcome content with your own and ship.tagline: Hello from my first edit!Save the file. The dev server picks up the change without a restart.
Next: deploy it.
Maintained by EkLine