valaxy-addon-bangumi

English | 简体中文

通过 ValaxyBangumi 组件，在 Valaxy 中展示 Bilibili 与 Bangumi 追番列表。

插件依赖 bilibili-bangumi-component，并需要后端服务。请参考它的后端部署文档完成部署。

安装 ​

bash
pnpm add valaxy-addon-bangumi

配置 ​

valaxy.config.ts
ts
import { defineValaxyConfig } from 'valaxy'
import { addonBangumi } from 'valaxy-addon-bangumi'

export default defineValaxyConfig({
  addons: [
    addonBangumi({
      api: 'https://your-bangumi-api.example.com',
      bilibiliUid: '1579790',
      bgmEnabled: false,
    }),
  ],
})

在 Markdown 中使用自动注册的组件：

md
---
title: Bangumi 追番列表
keywords: Bangumi
description: 我的 Bangumi 追番列表
---

<ValaxyBangumi />

样式覆盖 ​

bilibili-bangumi-component 使用 Web Component 实现。由于 Shadow DOM 会隔离样式，需要通过插件选项传入 customCss：

valaxy.config.ts
ts
import { defineValaxyConfig } from 'valaxy'
import { addonBangumi } from 'valaxy-addon-bangumi'

export default defineValaxyConfig({
  addons: [
    addonBangumi({
      customCss: '.bbc-bangumi-title a { color: red; }',
    }),
  ],
})

API ​

字段说明类型默认值
api后端 API 地址string—
bilibiliUidBilibili UID；后端通过环境变量提供时可省略string—
bgmUidBangumi UID；后端通过环境变量提供时可省略string—
bilibiliEnabled是否展示 Bilibili 条目booleantrue
bgmEnabled是否展示 Bangumi 条目booleantrue
pageSize每页条目数量number15
customEnabled是否启用自定义数据源booleanfalse
customLabel自定义数据源的标签string'自定义'
customCss注入 Web Component 的 CSSstring—

贡献者