# valaxy-addon-waline

> Waline Composition API for Valaxy

Latest version **0.2.1** (published 2025-04-01) · 0 weekly downloads

## Install

```sh
npm install valaxy-addon-waline
pnpm add valaxy-addon-waline
yarn add valaxy-addon-waline
bun add valaxy-addon-waline
```

## Health

**Score 50/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities; high maintenance score.

Warnings: low downloads; pre 1.0.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 0.2.1 |
| Published | 2025-04-01 |
| First published | 2022-09-18 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1127 |
| Maintainers | yunyoujun, wrxinyue |
| Keywords | valaxy, addon, waline |

## Links

- npm: https://www.npmjs.com/package/valaxy-addon-waline
- Repository: https://github.com/YunYouJun/valaxy.git#main
- Homepage: https://github.com/YunYouJun/valaxy/tree/main#readme
- Issues: https://github.com/YunYouJun/valaxy/issues
- npm.io page: https://npm.io/package/valaxy-addon-waline

## Dependencies (1)

- [@waline/client](https://npm.io/package/@waline/client.md) 3.4.1

## Recent versions

- 0.2.1 (latest) — 2025-04-01
- 0.2.0 — 2024-07-10
- 0.1.5 — 2024-07-09
- 0.1.4 — 2024-04-17
- 0.1.3 — 2024-04-16
- 0.1.2 — 2024-02-15
- 0.1.1 — 2023-10-02
- 0.1.0 — 2023-02-18
- 0.0.9 — 2023-01-24
- 0.0.8 — 2023-01-19
- 0.0.7 — 2023-01-13
- 0.0.6 — 2022-11-26
- 0.0.5 — 2022-11-24
- 0.0.4 — 2022-11-24
- 0.0.3 — 2022-11-23
- … 2 more at https://npm.io/package/valaxy-addon-waline/versions

## README

# valaxy-addon-waline

[![NPM version](https://img.shields.io/npm/v/valaxy-addon-waline?color=0078E7)](https://www.npmjs.com/package/valaxy-addon-waline)

valaxy-addon-waline 是基于 Waline 的一个 Valaxy 插件。

主题开发者可以通过将其作为依赖使用，以快速集成 Waline 评论组件。

> 除此之外，我们推荐您可以使用 [kotodama](https://github.com/YunYouJun/kotodama) 进行评论管理，它是一个基于 Waline 服务端实现的评论管理系统。

## 如何集成

```bash
npm i valaxy-addon-waline
```

### 主题使用者

用户启用 Waline 评论。

```ts
import { defineValaxyConfig } from 'valaxy'
import { addonWaline } from 'valaxy-addon-waline'

export default defineValaxyConfig({
  // or write it in site.config.ts
  siteConfig: {
    // 启用评论
    comment: {
      enable: true
    },
  },
  // 设置 valaxy-addon-waline 配置项
  addons: [
    addonWaline({
      serverURL: 'https://your-waline-url',
    }),
  ],
})
```

### 主题开发者

当用户启用 `valaxy-addon-waline` 插件时，`<WalineClient />` 组件将会被自动注册。

```vue
<!-- YunWaline -->
<script lang="ts" setup>
import { useAddonWaline } from 'valaxy-addon-waline'

const addon = useAddonWaline()
</script>

<template>
  <WalineClient w="full" :options="addon.options" />
</template>
```

## FAQ

### C() is not defined

`@waline/client@3.4.2` 有问题，锁定 `3.4.1`。

---
_Source: https://npm.io/package/valaxy-addon-waline · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._