jumpRedirect 外链中转

配置外链中转跳转功能，将站内点击的外部链接转换为通过中转页跳转，以保护用户隐私并提示即将离开本站。

外链中转配置文档页

中转页自动注入

启用 jumpRedirect.enable: true 后，主题会自动注入中转页，无需手动创建 redirect.md 或 public/redirect.html：

dev：通过 Vite 中间件拦截 /redirect 请求，直接返回中转页 HTML。
build：输出 redirect.html 到站点根目录，配合 cleanUrls 可通过 /redirect 访问。

中转页内置域名白/黑名单判断：白名单站点显示「已信任」并自动跳转，黑名单站点显示危险警告且不自动跳转，其余站点显示安全提示由用户确认。

链接改写的触发时机

中转页本身在 dev 与 build 均可直接访问 /redirect?url=<base64>。链接自动改写分两层：

构建期静态改写：pnpm build 时通过 transformHtml 把全部页面 HTML 中的外链替换为中转地址（生产环境首屏全覆盖）。
运行时补充改写：Twikoo 评论加载完成后，客户端会对当前文档的外链再执行一次改写，覆盖 SPA 路由切换后由客户端渲染的新内容（dev 环境同样生效）。

注意：SPA 路由切换后的运行时改写依赖评论系统（comment.enable: true）。若评论关闭，SPA 导航后的新页面外链将保持原始地址（首屏直开的页面仍被构建期改写覆盖）。开发期可手动构造 /redirect?url=<base64编码的目标URL> 测试中转页。

字段说明

字段	类型	默认值	说明
`enable`	`boolean`	`true`	是否启用外链中转
`exclude`	`string[]`	见下方说明	排除中转的链接 class 名数组
`whitelist`	`string[]`	见下方说明	域名白名单，匹配后自动跳转（支持通配符 `*.xxx`）
`blacklist`	`string[]`	见下方说明	域名黑名单，匹配后显示危险警告，不自动跳转

默认 exclude 值：

exclude: [
  'cf-friends-link', 'upyun', 'icp', 'author', 'rss', 'cc', 'power',
  'social-link', 'link-text', 'travellings', 'post-link', 'report',
  'more-link', 'skills-item', 'right-menu-link', 'link-card'
]

默认 whitelist 值（安全站点，进入中转页后自动跳转）：

whitelist: [
  'gitee.com', 'github.com', 'baidu.com', 'bing.cn', 'npmjs.com',
  'cnblogs.com', 'csdn.net', 'jianshu.com', 'zhihu.com', 'juejin.cn',
  'segmentfault.com', 'v2ex.com', 'google.com', 'google.cn',
  'google.com.*', 'vuejs.org'
]

默认 blacklist 值（购物站点，显示危险警告，不自动跳转）：

blacklist: ['taobao.com', 'jd.com', 'tmall.com', '1688.com', 'pinduoduo.com', 'amazon.com']

示例

使用默认配置

import { defineThemeConfig } from 'vitepress-theme-ninc/defineThemeConfig'

export const themeConfig = defineThemeConfig({
  jumpRedirect: {
    enable: true
    // exclude / whitelist / blacklist 均使用默认值
  }
})

关闭外链中转

import { defineThemeConfig } from 'vitepress-theme-ninc/defineThemeConfig'

export const themeConfig = defineThemeConfig({
  jumpRedirect: {
    enable: false
  }
})

自定义白/黑名单

import { defineThemeConfig } from 'vitepress-theme-ninc/defineThemeConfig'

export const themeConfig = defineThemeConfig({
  jumpRedirect: {
    enable: true,
    // 追加信任站点（defu 数组合并为 concat：你的项会追加在默认项之后，默认规则仍生效）
    whitelist: [
      'my-trusted-site.com' // 新增自定义信任站点（无需复制默认项，默认白名单仍保留）
    ]
  }
})

新增 exclude 排除项

import { defineThemeConfig } from 'vitepress-theme-ninc/defineThemeConfig'

export const themeConfig = defineThemeConfig({
  jumpRedirect: {
    enable: true,
    exclude: [
      'my-custom-link' // 新增自定义排除项（concat 追加，默认排除项仍保留）
    ]
  }
})

渲染效果

jumpRedirect 启用后，站内点击的外部链接不会直接跳转，而是先进入中转页：

中转提示页：展示「即将离开本站」提示，显示目标链接地址。
白名单自动跳转：目标域名命中白名单时，页面显示「已信任」并倒计时自动跳转。
黑名单警告：目标域名命中黑名单时，页面显示危险警告，需用户手动确认。
确认按钮：用户点击「继续前往」或按 Enter 键后跳转到目标外链。
复制链接：点击目标链接地址可复制到剪贴板。

常见配置组合

默认启用：开箱即用，默认 exclude / whitelist / blacklist 已覆盖常见场景。
追加自定义排除：在自定义组件中使用 link-card 等类名时，将类名追加到 exclude（concat 合并，默认项自动保留，无需复制）。
完全关闭：enable: false 适合纯内链站点或对中转页无需求的场景。

数组为 concat 追加而非整体替换

由于 defu 对数组的合并策略是 concat 追加，传入 exclude / whitelist / blacklist 时你的项会追加在默认项之后（默认规则仍然生效，不会丢失）。如果你确实想丢弃全部默认规则、只保留自己定义的项，需要把默认项中想保留的部分一并写入（完整默认值见本页字段表或 defaultThemeConfig 源码）。

注意事项

外链中转保护用户隐私

启用后，站内点击的外部链接不会直接跳转，而是先进入中转页（提示「即将离开本站」），再由用户确认跳转。这能避免 Referer 头泄露本站地址，保护访客隐私，同时给用户一次反悔机会，防止误触与钓鱼链接。

exclude 基于 class 名匹配

exclude 数组中的每一项是 链接元素的 class 名。带这些 class 的链接（无论是否外链）都会跳过中转页直接打开。默认排除项覆盖了友链、ICP 备案、作者、RSS、CC 协议、社交链接、开往、文章链接、举报、更多链接、技能项、右键菜单链接、链接卡片等内部或友好链接场景。

whitelist / blacklist 基于域名匹配

whitelist / blacklist 在中转页内对目标 URL 的 hostname 做匹配，支持 * 通配符（如 google.com.*）。黑名单优先于白名单判断。这两个数组在中转页 HTML 生成时注入，修改后需重新构建。

默认启用

jumpRedirect 默认 enable: true，新站点开箱即得外链中转保护。若希望外链直接跳转可设为 enable: false。

自定义链接卡片需加入 exclude

若在文章中使用 link-card 等自定义组件并希望其中的链接直接跳转，请确保对应 class 名已存在于 exclude 中。默认已包含 link-card。

jumpRedirect 外链中转 ​

中转页自动注入 ​

字段说明 ​

示例 ​

使用默认配置 ​

关闭外链中转 ​

自定义白/黑名单 ​

新增 exclude 排除项 ​

渲染效果 ​

注意事项 ​

相关配置 ​