---
title: "Quick Start"
description: "Create your first svedocs site, learn its project structure, and prepare it for production."
---

> Documentation Index
> Fetch the complete documentation index at: https://svedocs.pwp.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# Quick Start

svedocs handles the documentation-specific parts of a SvelteKit app: Markdown content, routes and navigation, theming, search, Ask AI, SEO, Open Graph images, content checks, and Cloudflare deployment.

The quickest way to get familiar with it is to generate a project and replace the sample pages with your own.

## Create a site

```sh
pnpm create svedocs my-docs --template docs
cd my-docs
pnpm install
pnpm dev
```

Open the local URL printed by the dev server. The `docs` template is ready to use: it includes sample pages, local search, an Ask AI route that works without credentials, sitemap and robots routes, an optional RSS route, and Open Graph images.

For a smaller starting point or Cloudflare bindings, see [Choose a template](/docs/installation#choose-a-template). To integrate an existing app, follow [Installation](/docs/installation#add-svedocs-to-an-existing-app).

## Build with an agent

To have your coding agent build a site around an existing project, [copy the ready-to-use prompt](/#build-with-an-agent) on the homepage. A [plain-text version](https://svedocs.pwp.sh/prompts/build-docs.en.txt) is also available.

Paste it into your agent with the project open. It covers installing the [official skills](https://github.com/backrunner/svedocs/tree/main/skills), reading the codebase, creating a custom theme and landing page, writing accurate docs, configuring SEO, and verifying the result. Add a preferred site directory, language, domain, or hosting target if you already have one.

Generated projects include these skills in `.agents/skills`. The core skills are `use-svedocs`, `configure-svedocs`, `customize-svedocs-theme`, and `build-svedocs-landing`; use `localize-svedocs` when adding languages.

## Project anatomy

A generated project stays small:

```txt
my-docs/
  content/
    docs/
      index.md
    pages/
      index.md
  src/routes/
    [...path]/+page.svelte
    api/search/+server.ts
    api/ask/+server.ts
    og/[...path]/+server.ts
    sitemap.xml/+server.ts
    feed.xml/+server.ts
    robots.txt/+server.ts
  svedocs.config.ts
  vite.config.ts
```

Most day-to-day work happens in `content/docs`, `content/pages`, and `svedocs.config.ts`. The route files mostly connect data generated by the Vite plugin to the theme and server endpoints, so you rarely need to edit them.

## Write your first page

Create `content/docs/getting-started.md`:

````md title="content/docs/getting-started.md"
---
title: Getting Started
description: Learn the first workflow in this product.
order: 2
---

# Getting Started

Use this page to explain the first successful path.

## Install

```sh
pnpm add your-package
```
````

svedocs maps the file to `/docs/getting-started`, adds it to the sidebar, extracts `Install` for the page table of contents, and creates search records for both the page and section.

## Development workflow

Keep these commands running as part of the writing loop:

```sh
pnpm dev
pnpm check
pnpm exec svedocs check --strict
pnpm build
```

`svedocs check` catches missing descriptions, duplicate routes, duplicate canonical URLs, broken internal links, missing anchors, missing assets, translation gaps, and package export issues when requested.

## Prepare to publish

Set `site.name`, `site.description`, and `site.url` in `svedocs.config.ts`, then rerun the checks and build. Follow [Cloudflare deployment](/docs/integrations/cloudflare) to publish the default edge build, or choose [static output](/docs/configuration#build-modes) for a static host.

## Where to go next

- [Installation](/docs/installation): add svedocs to a new or existing SvelteKit app.
- [Writing](/docs/writing): learn the content model, frontmatter, Markdown features, and SVX authoring.
- [Configuration](/docs/configuration): tune metadata, routing, theme, search, AI, SEO, checks, and Cloudflare settings.
- [Integrations](/docs/integrations): connect search, Ask AI, Cloudflare, SEO, and OG routes.
- [CLI](/docs/reference/cli): use the command surface for build, checks, indexing, OG assets, deployment helpers, and upgrades.

Source: https://svedocs.pwp.sh/docs