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

外部链接

更新于 2026年11月12日

links 数组将外部 URL 添加到顶栏或侧边栏。每一项都渲染为一个链接，可附带图标。

基本用法

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

export default defineConfig({
  include: "docs/**/*.md",
  links: [
    {
      url: "https://github.com/acme/docs",
      title: "GitHub",
      icon: "github",
    },
  ],
})

字段

字段类型默认值用途
urlstring—外部 URL。
titlestring—显示的文字。
iconstring—Lucide 图标名（例如 github、twitter、mail）。
prefixstring—栏目路径前缀；设置后，链接只在该栏目中显示。
position"header" | "sidebar""header"链接的渲染位置。

图标来自 lucide-react。请使用 kebab-case 名称。

默认情况下，链接渲染在顶栏中栏目标签页的右侧。只会显示你设置的 icon，Livemark 不会自行添加外部链接标记。

links: [
  { url: "https://github.com/acme/docs", title: "GitHub", icon: "github" },
  { url: "https://twitter.com/acme", title: "Twitter", icon: "twitter" },
]

设置 position: "sidebar"，即可将链接渲染在左侧边栏中、栏目树的下方。

links: [
  {
    url: "https://github.com/acme/docs/edit/main",
    title: "Edit on GitHub",
    icon: "pencil",
    position: "sidebar",
  },
]

使用 prefix，可以让链接只在特定栏目处于激活状态时显示。这适用于按栏目设置的 “在 GitHub 上编辑” 或 “报告问题” 等快捷入口。

links: [
  {
    url: "https://github.com/acme/docs/edit/main/blog",
    title: "Edit on GitHub",
    icon: "pencil",
    prefix: "/blog/",
    position: "sidebar",
  },
]

另请参阅

用 ❤ 和 Livemark 构建