技术预览提交反馈
Livemark
Livemark静态站点生成器

配置文件

更新于 2026年11月12日

Livemark 通过项目根目录下的单个文件进行配置：livemark.config.ts。把它放在 package.json 旁边，导出一个 defineConfig({...}) 调用，Livemark 就会自动识别它，无需任何命令行参数或环境变量。

最小配置

所有字段都是可选的。最小的有效配置就是一个空调用：

livemark.config.ts
import { defineConfig } from "livemark"

export default defineConfig({})

这会读取项目下的所有 .md 文件（默认 include: "**/*.md"），并使用标准的 Livemark 主题渲染：侧边栏、搜索、语法高亮、深色模式，全部采用默认设置。

可配置的内容

每个字段都有合理的默认值。完整列表：

选项类型用途
includestring | string[]内容文件的 glob。默认："**/*.md"。
excludestring | string[]要跳过的 glob（草稿、片段等）。
titlestring显示在顶栏和 <title> 中的站点标题。默认："Livemark"。
descriptionstring用于 SEO/Open Graph 的 meta 描述。默认："Markdown site generator"。
sitestring站点的规范 URL，生成 sitemap 时必需。
basestring | (command) => string站点所在的子路径，例如在 GitHub Pages 上。
faviconstringfavicon 图片的路径，相对于项目根目录。
logostring顶栏中使用的 logo 图片路径（未设置时回退到内置的 Livemark logo）。
bannerstring显示在顶栏上方横条中的行内 Markdown 公告。
head{ meta, links, scripts }为每个页面添加的额外 <head> 标签。
breadcrumbsboolean在每篇文章标题上方显示文件夹层级的面包屑导航。默认：true。
languagesLanguage[]翻译：每种语言一项，第一项为默认语言。
codeThemeLightShiki 主题名浅色模式的语法主题。默认："catppuccin-latte"。
codeThemeDarkShiki 主题名深色模式的语法主题。默认："catppuccin-mocha"。
sectionsSection[]将内容拆分为文档 / 博客 / 更新日志，各自拥有 URL 前缀。
linksLink[]显示在顶栏或侧边栏中的自定义链接。
patchesPatch[]在配置中覆盖 Markdown 文件的 frontmatter，无需编辑文件。
contentSignalsContentSignals发布在 robots.txt 中的 AI 使用偏好。默认：全部为 true。
skillsstring | string[]要作为智能体技能发布的 SKILL.md 文件的 glob。
plugins{ md, html }你自己的 Markdown 与 HTML 插件，加入文章编译管线。
allowDangerousHtmlboolean保留 Markdown 中写的原始 HTML 并允许 MDX 文章。false 会丢弃原始 HTML，遇到任何 MDX 文章都会报错。默认：true。
viteUserConfig | (env) => UserConfig额外的 Vite 配置，合并到 Livemark 自身配置之上。

完整的 schema 位于 livemark/source/models/config.ts：defineConfig 会用 Zod 依据它进行校验。未知的键会被拒绝——无论是在顶层，还是在 sections、links、languages、head、contentSignals 和 patches 内部——因此拼写错误会在启动时给出清晰的报错，而不会被静默忽略。

title、description 和 banner 可以是字符串，也可以是按语言代码分别给出的值。

完整示例

大多数真实站点最终都类似这样：

livemark.config.ts
import { defineConfig } from "livemark"

export default defineConfig({
  title: "My docs",
  description: "Documentation for my project",
  site: "https://docs.example.com",
  include: ["docs/**/*.md", "blog/**/*.md"],
  exclude: "docs/**/_*",
  sections: [
    { title: "Docs", prefix: "/" },
    { title: "Blog", prefix: "/blog/", type: "blog" },
  ],
  links: [
    {
      url: "https://github.com/example/project",
      title: "GitHub",
      icon: "github",
    },
  ],
})

下一步

用 ❤ 和 Livemark 构建