Skip to content
Select theme

Quickstart

  1. Create your site.

    Terminal window
    npm create astro@latest -- --template ekline-io/potluck-docs/packages/template --no-ai

    You’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-astro adds a generic AGENTS.md pointing coding assistants at general Astro documentation, which contradicts the Starlight rules the template ships in CLAUDE.md. One more thing to know: whatever you name the directory becomes the name in your package.json, so change it later if that isn’t what you want.

  2. Start the dev server.

    Terminal window
    cd my-docs
    npm run dev

    Your site is live at localhost:4321 with hot reload.

  3. Make your first edit.

    Open src/content/docs/index.mdx and change the tagline under hero:

    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