KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agents #developer-tools #typescript #codex #cli #claude-code #mcp #rust #deepseek-harness #ai-agent

svelte-sitemap

★ 357 Open GitHub ↗

Sitemap generator for SvelteKit. Small helper which scans your SvelteKit routes and generates static sitemap.xml

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![npm version](https://badge.fury.io/js/svelte-sitemap.svg)](https://badge.fury.io/js/svelte-sitemap)
[![Package License](https://img.shields.io/npm/l/svelte-sitemap.svg)](https://www.npmjs.com/svelte-sitemap)
[![Build & Publish](https://github.com/bartholomej/svelte-sitemap/workflows/Build%20&%20Publish/badge.svg)](https://github.com/bartholomej/svelte-sitemap/actions)

# 🗺️ Svelte `sitemap.xml` generator

**Generates `sitemap.xml` from your SvelteKit static routes — automatically, on every build.**

---

- ➡️ Designed for SvelteKit `adapter-static` with `prerender` option (SSG)
- 🔷 TypeScript, JavaScript, CLI and **Vite plugin** version
- 🔧 Useful [options](#%EF%B8%8F-options) for customizing your sitemap
- 🗂️ Support for [sitemap index](https://developers.google.com/search/docs/crawling-indexing/sitemaps/large-sitemaps) for large sites (50K+ pages)
- ▲ 🟠 Works with [Vercel](#-vercel-adapter) and [Cloudflare](#-cloudflare-adapter) adapters and more...

## 📦 Install

```bash
npm install svelte-sitemap --save-dev
# yarn add svelte-sitemap --dev
# pnpm add -D svelte-sitemap
# bun add -d svelte-sitemap
```

## 🚀 Usage

> If you're using SvelteKit with Vite (which is the default), you can integrate the sitemap generation directly into the Vite build pipeline.

Add the plugin to your `vite.config.ts`:

```typescript
// vite.config.ts
import { sveltekit } from '@sveltejs/kit/vite';
import { svelteSitemap } from 'svelte-sitemap/vite'; // <-- Add svelte-sitemap vite plugin
import { defineConfig } from 'vite';

export default defineConfig({
 plugins: [
 sveltekit(),
 svelteSitemap({ domain: 'https://example.com' }) // <-- Configure the plugin with your options
 ]
});
```

The sitemap is generated automatically at the end of every `vite build`. All [options](#%EF%B8%8F-options) are supported.

---

### Alternative Methods

For other setups, the following methods are still supported but are deprecated in favor of the Vite plugin.

<details>
<summary>✨ Config file</summary>

> [!WARNING]
> Running the generator via CLI is an alternative. We recommend migrating to the **Vite plugin** instead.

Create a config file `svelte-sitemap.config.ts` in the root of your project:

```typescript
// svelte-sitemap.config.ts
import type { OptionsSvelteSitemap } from 'svelte-sitemap';

const config: OptionsSvelteSitemap = {
  domain: 'https://www.example.com',
  trailingSlashes: true
  // ...more options below
};

export default config;
```

Then add `svelte-sitemap` as a `postbuild` script in `package.json`:

```json
{
  "scripts": {
    "postbuild": "npx svelte-sitemap"
  }
}
```

After every `build`, the sitemap is generated in your `build/` folder.

</details>

<details>
<summary>⌨️ CLI flags (Deprecated)</summary>

> [!WARNING]
> Passing configuration options directly as CLI flags is deprecated and will be removed in a future version. Please use the **Vite plugin** or a **config file** instead.

Pass options directly as CLI flags — no config file needed:

```json
{
  "scripts": {
    "postbuild": "npx svelte-sitemap --domain https://myawesomedomain.com"
  }
}
```

See all available flags in the [Options](#%EF%B8%8F-options) table below.

</details>

<details>
<summary>🔧 JavaScript / TypeScript API</summary>

Sometimes it's useful to call the script directly from code:

```typescript
// my-script.js
import { createSitemap } from 'svelte-sitemap';

createSitemap({ domain: 'https://example.com', debug: true });
```

Run your script:

```bash
node my-script.js
```

</details>

---

## ⚙️ Options

Options are defined as **config file keys** (camelCase). Use it in your `svelte-sitemap.config.ts` file.
_The same options are also available as **CLI flags** for legacy use._

| Config key        | CLI flag                   | Description                                                                                                         | Default | Example                                     |
| ----------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------- | ------------------------------------------- |
| `domain`          | `--domain`, `-d`           | Your domain **[required]**                                                                                          | -       | `domain: 'https://mydomain.com'`            |
| `outDir`          | `--out-dir`, `-o`          | Custom build folder                                                                                                 | `build` | `outDir: 'dist'`                            |
| `additional`      | `--additional`, `-a`       | Additional pages outside of SvelteKit                                                                               | -       | `additional: ['my-page', 'my-second-page']` |
| `ignore`          | `--ignore`, `-i`           | Ignore files or folders (glob patterns)                                                                             | `[]`    | `ignore: ['**/admin/**', 'my-secret-page']` |
| `trailingSlashes` | `--trailing-slashes`, `-t` | Add trailing slashes                                                                                                | `false` | `trailingSlashes: true`                     |
| `resetTime`       | `--reset-time`, `-r`       | Set lastModified time to now                                                                                        | `false` | `resetTime: true`                           |
| `changeFreq`      | `--change-freq`, `-c`      | Set change frequency [options](https://github.com/bartholomej/svelte-sitemap/blob/master/src/dto/global.dto.ts#L23) | -       | `changeFreq: 'daily'`                       |
| `debug`           | `--debug`                  | Show some useful logs                                                                                               | -       | `debug: true`                               |
| -                 | `--help`, `-h`             | Display usage info                                                                                                  | -       | -                                           |
| -                 | `--version`, `-v`          | Show version                                                                                                        | -       | -                                           |

## 🔄 Migration to Vite Plugin

Migrating from the CLI or config file to the Vite plugin is quick and straightforward:

1. **Remove `svelte-sitemap` from `package.json` scripts:**

```diff
   {
     "scripts": {
   -   "postbuild": "npx svelte-sitemap"
     }
   }
   ```

2. **Copy options from your config file** (e.g., `svelte-sitemap.config.ts`) if you have one, and then **delete it**.

3. **Register the plugin in `vite.config.ts`:**
   Import `svelteSitemap` and configure your options directly inside the plugin. The options object is 100% compatible, so you can copy and paste your configuration directly into `svelteSitemap({...})`:

```typescript
   // vite.config.ts
   import { sveltekit } from '@sveltejs/kit/vite';
   import { svelteSitemap } from 'svelte-sitemap/vite';
   import { defineConfig } from 'vite';

export default defineConfig({
     plugins: [
       sveltekit(),
       svelteSitemap({
         domain: 'https://example.com'
         // Paste your options object from svelte-sitemap.config.ts here.
         // Note: If migrating from CLI flags, convert kebab-case flags to camelCase options:
         // e.g. --ignore -> ignore: ['**/admin/**']
         //      --out-dir -> outDir: 'dist'
       })
     ]
   });
   ```

---

## 🙋 FAQ

### 🙈 How to exclude a directory?

Use `ignore` with glob patterns. For example, to ignore all `admin` folders and one specific page:

```typescript
// svelte-sitemap.config.ts
import type { OptionsSvelteSitemap } from 'svelte-sitemap';

const config: OptionsSvelteSitemap = {
  domain: 'https://www.example.com',
  ignore: ['pages/my-secret-page', '**/admin/**']
};
```

---

### ▲ Vercel adapter

If you're using `adapter-vercel`, the output directory is different from the default `build/`:

```typescript
// svelte-sitemap.config.ts
import type { OptionsSvelteSitemap } from 'svelte-sitemap';

const config: OptionsSvelteSitemap = {
  domain: 'https://www.example.com',
  outDir: '.vercel/output/static'
};
```

Or check out [other solutions](https://github.com/bartholomej/svelte-sitemap/issues/16#issuecomment-961414454) and join the discussion.

---

### 🟠 Cloudflare adapter

If you're using `@sveltejs/adapter-cloudflare`, you need to exclude `sitemap.xml` from Cloudflare's routing in `svelte.config.js`:

```diff
-import adapter from '@sveltejs/adapter-auto';
+import adapter from '@sveltejs/adapter-cloudflare';

/** @type {import('@sveltejs/kit').Config} */
const config = {
 kit: {
- adapter: adapter()
+ adapter: adapter({ routes: { include: ['/*'], exclude: ['<all>', '/sitemap.xml'] }})
 }
};

export default config;
```

---

## 🐞 Common issues

### ❌ Error: Missing folder

```
× Folder 'build/' doesn't exist. Make sure you are using this library as 'postbuild'
  so 'build/' folder was successfully created before running this script.
```

Make sure the output folder exists. If your build outputs to a different folder than `build/`, use the `outDir` option in your config file.

---

### ❌ Error: Missing html files

```
× There is no static html file in your 'build/' folder.
  Are you sure you are using Svelte adapter-static with prerender option?
```

This library is intended for `adapter-static` with the `prerender` option (SSG). If there are no static HTML files in your build folder, this library won't work for you :'(

---

## ⭐️ Show your support

Give a ⭐️ if this project helped you!

Or if you are brave enough consider [making a donation](https://github.com/sponsors/bartholomej) for some 🍺 or 🍵 ;)

## 🕵️ Privacy Policy

I DO NOT STORE ANY DATA. PERIOD.

I physically can't. I have nowhere to store it. I don't even have a server database to store it. So even if Justin Bieber asked nicely to see your data, I wouldn't have anything to show him.

That's why, with this library, what happens on your device stays on your device till disappear.

## 🤝 Contributing

I welcome you to customize this according to your needs ;)

Pull requests for any improvements would be great!

Feel free to check [issues page](https://github.com/bartholomej/svelte-sitemap/issues).

### 🛠️ Developing and debugging this library

```bash
git clone git@github.com:bartholomej/svelte-sitemap.git
cd svelte-sitemap
yarn
yarn start
```

#### Run demo locally

You can find and modify it in [`./demo.ts`](./demo.ts) file

```bash
yarn demo
```

## 🙏 Credits

- svelte-sitemap is a workaround for [this official SvelteKit issue](https://github.com/sveltejs/kit/issues/1142)
- Brand new version is inspired by [Richard's article](https://r-bt.com/learning/sveltekit-sitemap/)
- Thanks to [@auderer](https://github.com/auderer) because [his issue](https://github.com/bartholomej/svelte-sitemap/issues/1) changed the direction of this library

## 📝 License

Proudly powered by nature 🗻, wind 💨, tea 🍵 and beer 🍺 ;)

All contents are licensed under the [MIT license].

[mit license]: LICENSE

svelte-sitemap

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README