快速开始

环境要求

• Node.js ^20.19.0 或 >=22.12.0
• Svelte 5、SvelteKit 2（2.65.1 及以上）或 SvelteKit 3，以及 Vite 8
• 推荐 pnpm 10；创建命令同时支持 npm、Yarn 和 Bun

创建一个项目

根据您所使用的包管理工具选择运行以下命令：

npm create @sveltepress@latest

添加到一个已经存在的 Sveltekit 项目

安装 Vite 插件

npm install --save @sveltepress/vite

在 vite.config.(js|ts) 中替换 sveltekit 插件

import {  } from '@sveltejs/kit/vite' 

import {  } from '@sveltepress/vite' 

import {  } from 'vite'

const  = ({
  : [
    (), 
    (), 
  ],
})

export default 

通过 sveltepress() 传入 SvelteKit 配置

import  from '@sveltejs/adapter-static'
import {  } from '@sveltejs/vite-plugin-svelte'
import {  } from '@sveltepress/vite'
import {  } from 'vite'

export default ({
  : [
    ({
      : {
        : [()],
        : ({
          : 'dist',
        }),
      },
    }),
  ],
})

import  from '@sveltejs/adapter-static'
import {  } from '@sveltejs/vite-plugin-svelte'

/**
 * @type {import('@sveltejs/kit').Config}
 */
const  = {
  : ['.svelte'], 
  : ['.svelte', '.md'], // add .md here 
  : [()],
  : {
    : ({
      : 'dist',
    }),
  },
}

export default 

升级到 SvelteKit 3

1. 将 @sveltejs/kit 升级到 ^3.0.0，并将 adapter 升级到其支持 SvelteKit 3 的版本，例如 @sveltejs/adapter-static ^4.0.0。SvelteKit 3 需要 Node.js >=22.17。
2. 运行 npx sv migrate sveltekit-3 迁移你自己的代码，例如 $app/stores、$app/paths 中的 base 以及 $lib 导入。
3. 确保 SvelteKit 配置位于 sveltepress({ svelteKitOptions }) 中（见上文）。迁移工具会把 svelte.config.js 移到 Vite 配置中的 sveltekit(...) 调用里：请把该对象移到 svelteKitOptions 中，并移除 sveltekit(...) 插件。

Sveltepress 本身无需其他改动。请注意：

• $lib 被 #lib 子路径导入取代。 版本管理 会像跟踪 $lib/ 一样跟踪 #lib/ 导入；如果你的 manifest 共享了 $lib/**，请同时在 content.shared 中添加 #lib/**。
• 默认主题的 pwa 选项依赖 @vite-pwa/sveltekit，而它暂不支持 SvelteKit 3。在 SvelteKit 3 下不会生成 service worker，构建时会输出警告。