valaxy-addon-bangumi

English | 简体中文

Display Bilibili and Bangumi watch lists in Valaxy through the ValaxyBangumi component.

The addon uses bilibili-bangumi-component and requires a backend service. Follow its backend guide to deploy one.

Installation ​

bash
pnpm add valaxy-addon-bangumi

Configuration ​

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,
    }),
  ],
})

Use the registered component in Markdown:

md
---
title: Bangumi watch list
keywords: Bangumi
description: My Bangumi watch list
---

<ValaxyBangumi />

Style overrides ​

bilibili-bangumi-component is implemented as a Web Component. Because Shadow DOM isolates its styles, pass customCss through the addon options:

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 ​

FieldDescriptionTypeDefault
apiBackend API URLstring—
bilibiliUidBilibili UID; optional when the backend supplies it through environment variablesstring—
bgmUidBangumi UID; optional when the backend supplies it through environment variablesstring—
bilibiliEnabledDisplay Bilibili entriesbooleantrue
bgmEnabledDisplay Bangumi entriesbooleantrue
pageSizeNumber of entries per pagenumber15
customEnabledEnable a custom data sourcebooleanfalse
customLabelLabel for the custom data sourcestring'Custom'
customCssCSS injected into the Web Componentstring—

Contributors