第三方集成

本地搜索（基于 fuse.js） ​

Valaxy 内置了基于 fuse.js 的离线搜索（须预先通过 valaxy fuse 构建生成本地缓存）。

valaxy fuse 默认将 fuse 生成在 public 目录下，并在 .gitignore 中添加 public/valaxy-fuse-list.json 忽略。 在执行 valaxy build 之前，会自动执行 valaxy fuse。

如果你想要使用全文搜索，可参考 Options | fuse.js 进行设置。 譬如：

site.config.ts
ts
export default defineSiteConfig({
  search: {
    enable: true,
    type: 'fuse',
  },
  fuse: {
    /**
     * 设置搜索的文件路径
     */
    // pattern: 'pages/**/*.md',
    options: {
      keys: ['title', 'tags', 'categories', 'excerpt', 'content'],
      /**
       * @default 0.6
       * @see https://www.fusejs.io/api/options.html#threshold
       * 设置匹配阈值，越低越精确
       */
      // threshold: 0.6,
      /**
       * @default false
       * @see https://www.fusejs.io/api/options.html#ignoreLocation
       * 忽略位置
       * 这对于搜索文档全文内容有用，若无需全文搜索，则无需设置此项
       */
      ignoreLocation: true,
    },
  },
})

使用 ​

site.config.ts
ts
import { defineSiteConfig } from 'valaxy'

export default defineSiteConfig({
  search: {
    enable: true,
    // 设置类型为 Fuse
    provider: 'fuse',
  },
})
  • 在你的 package.json 中添加 fuse 生成脚本
package.json
json
{
  "name": "yun-demo",
  "valaxy": {
    "theme": "yun"
  },
  "scripts": {
    "build": "npm run build:ssg",
    "build:ssg": "valaxy build --ssg",
    "fuse": "valaxy fuse",
    "rss": "valaxy rss"
  },
  "dependencies": {
    "valaxy": "latest",
    "valaxy-theme-yun": "latest"
  }
}

Algolia 搜索 ​

Algolia 是一个在线第三方搜索服务，您需要自行申请相关 ID 和 Secret。

DocSearch 申请通常只接受技术文档。

Valaxy 提供了一个快速集成插件 valaxy-addon-algolia（目前仅支持 DocSearch）。

音乐播放器 ​

由 valaxy-addon-meting 插件提供，基于 APlayer 与 MetingJS 实现。

已迁移为插件

旧版核心的 aplayer: true frontmatter 开关已在 v1.0 中移除。音乐播放器现由 valaxy-addon-meting 插件提供——将其加入配置即可使用。

安装并启用插件：

ts
// valaxy.config.ts
import { defineConfig } from 'valaxy'
import { addonMeting } from 'valaxy-addon-meting'

export default defineConfig({
  addons: [
    addonMeting({
      // 设为 `global: true` 可在每个页面显示固定播放器
      global: false,
    }),
  ],
})

随后在文章中任意位置放入 <meting-js> 元素（例如网易云某首歌曲，id 为歌曲 ID）：

html
<meting-js
 id="22736708"
 server="netease"
 type="song"
 theme="#C20C0C">
</meting-js>

提示：aplayer: true frontmatter 仍被插件支持，用于按页切换全局固定播放器的显隐。完整选项见 插件 README。

效果如下：

More info see Option | MetingJS

谷歌统计 ​

可参见 扩展 Client 上下文｜自定义扩展

你可以通过直接使用 Vue 插件的方式引入谷歌统计。

譬如：

  • 安装依赖：pnpm add vue-gtag-next
  • 新建 setup/main.ts:
setup/main.ts
ts
import { defineAppSetup } from 'valaxy'
import { install as installGtag } from './gtag'

export default defineAppSetup((ctx) => {
  installGtag(ctx)
})
  • 新建 setup/gtag.ts:
setup/gtag.ts
ts
import type { UserModule } from 'valaxy'
import VueGtag, { trackRouter } from 'vue-gtag-next'

export const install: UserModule = ({ isClient, app, router }) => {
  if (isClient) {
    app.use(VueGtag, {
      property: { id: 'G-1LL0D86CY9' },
    })

    trackRouter(router)
  }
}

More info see vue-gtag-next.

To Be Continued.

贡献者