@kawapress/plugin-comments 0.1.0 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +38 -127
- package/README.zh-CN.md +39 -128
- package/package.json +6 -6
- package/src/frontmatter.ts +12 -0
- package/src/index.ts +1 -0
package/README.md
CHANGED
|
@@ -1,156 +1,67 @@
|
|
|
1
|
-
|
|
2
|
-
<picture>
|
|
3
|
-
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ShenQingchuan/kawapress/main/docs/public/kawapress-logo-dark.png">
|
|
4
|
-
<img src="https://raw.githubusercontent.com/ShenQingchuan/kawapress/main/docs/public/kawapress-logo.png" alt="KawaPress" width="180">
|
|
5
|
-
</picture>
|
|
6
|
-
</p>
|
|
1
|
+
# @kawapress/plugin-comments
|
|
7
2
|
|
|
8
|
-
|
|
3
|
+
GitHub Discussions comments for KawaPress, powered by Giscus.
|
|
9
4
|
|
|
10
|
-
|
|
11
|
-
<strong>A Vue-first static site generator for documentation and content-focused websites.</strong>
|
|
12
|
-
</p>
|
|
5
|
+
[](https://www.npmjs.com/package/@kawapress/plugin-comments) · [简体中文](https://github.com/kawapress/kawapress/blob/main/packages/plugin-comments/README.zh-CN.md)
|
|
13
6
|
|
|
14
|
-
|
|
15
|
-
Write in Markdown. Develop with real SSR. Extend everything through public APIs.
|
|
16
|
-
</p>
|
|
7
|
+
`@kawapress/plugin-comments` is part of [KawaPress](https://github.com/kawapress/kawapress), a Vue-first static site generator.
|
|
17
8
|
|
|
18
|
-
|
|
19
|
-
<a href="https://www.npmjs.com/package/kawapress"><img src="https://img.shields.io/npm/v/kawapress?label=npm&color=42b883" alt="npm version"></a>
|
|
20
|
-
<a href="https://github.com/ShenQingchuan/kawapress/actions/workflows/deploy-pages.yml"><img src="https://github.com/ShenQingchuan/kawapress/actions/workflows/deploy-pages.yml/badge.svg" alt="documentation build"></a>
|
|
21
|
-
<a href="https://github.com/ShenQingchuan/kawapress/blob/main/LICENSE"><img src="https://img.shields.io/github/license/ShenQingchuan/kawapress" alt="MIT license"></a>
|
|
22
|
-
<img src="https://img.shields.io/badge/Node.js-%E2%89%A522.12-339933?logo=nodedotjs&logoColor=white" alt="Node.js 22.12 or newer">
|
|
23
|
-
</p>
|
|
9
|
+
## Features
|
|
24
10
|
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
11
|
+
- Comments live in GitHub Discussions, so the site needs no database and no login system.
|
|
12
|
+
- The build writes only a heading and an empty container. The Giscus script loads when the section is about to scroll into view.
|
|
13
|
+
- The thread follows the site light and dark appearance, and the interface language of the site.
|
|
14
|
+
- Moving to another page builds a fresh thread for it.
|
|
15
|
+
- Turn comments off for one page with `comments: false`.
|
|
30
16
|
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
## Why KawaPress?
|
|
34
|
-
|
|
35
|
-
KawaPress turns Markdown into pre-rendered Vue websites. It keeps the familiar simplicity of a documentation generator while giving themes and plugins the same public extension points used by the official experience.
|
|
36
|
-
|
|
37
|
-
- **Real SSR during development** — every initial request is server-rendered, so SSR-only problems appear before build or deployment.
|
|
38
|
-
- **A complete default experience** — the built-in nagi (凪) preset includes responsive documentation layouts, dark mode, local search, syntax highlighting, Twoslash, code groups, multilingual navigation, and more.
|
|
39
|
-
- **Vue from end to end** — Markdown becomes Vue components, Vue Router handles navigation, and regular Vue SFCs fit naturally into content.
|
|
40
|
-
- **AI-ready output** — nagi generates page-level Markdown, locale-aware `llms.txt` and `llms-full.txt`, plus built-in copy actions.
|
|
41
|
-
- **One extension model** — Generator Plugins, Runtime Plugins, and Presets cover build-time behavior, the Vue runtime, themes, and reusable product setups without private theme hooks.
|
|
42
|
-
|
|
43
|
-
KawaPress is an independent project. It is not a VitePress fork or a drop-in replacement, and it intentionally does not use VitePress configuration.
|
|
44
|
-
|
|
45
|
-
## Quick Start
|
|
46
|
-
|
|
47
|
-
You need [Node.js](https://nodejs.org/) 22.12 or newer.
|
|
48
|
-
|
|
49
|
-
Create a new site with the scaffolder:
|
|
17
|
+
## Install
|
|
50
18
|
|
|
51
19
|
```sh
|
|
52
|
-
npm
|
|
53
|
-
cd my-kawapress-site
|
|
54
|
-
npm run dev
|
|
20
|
+
npm install --save-dev @kawapress/plugin-comments
|
|
55
21
|
```
|
|
56
22
|
|
|
57
|
-
`pnpm
|
|
23
|
+
`pnpm add --save-dev @kawapress/plugin-comments` and `yarn add --dev @kawapress/plugin-comments` work too.
|
|
58
24
|
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
```sh
|
|
62
|
-
mkdir my-kawapress-site
|
|
63
|
-
cd my-kawapress-site
|
|
64
|
-
pnpm init
|
|
65
|
-
pnpm add --save-dev kawapress
|
|
66
|
-
```
|
|
25
|
+
## Usage
|
|
67
26
|
|
|
68
|
-
|
|
27
|
+
Prepare a public repository with Discussions turned on, install the [giscus app](https://github.com/apps/giscus), then copy the four values from [giscus.app](https://giscus.app):
|
|
69
28
|
|
|
70
29
|
```ts
|
|
30
|
+
import commentsPlugin from '@kawapress/plugin-comments'
|
|
71
31
|
import { nagi } from 'kawapress/nagi'
|
|
72
32
|
|
|
73
33
|
export default nagi({
|
|
74
|
-
|
|
34
|
+
plugins: [
|
|
35
|
+
commentsPlugin({
|
|
36
|
+
giscus: {
|
|
37
|
+
repo: 'your-name/your-repo',
|
|
38
|
+
repoId: 'R_kgDOxxxxxxx',
|
|
39
|
+
category: 'Comments',
|
|
40
|
+
categoryId: 'DIC_kwDOxxxxxxx',
|
|
41
|
+
},
|
|
42
|
+
}),
|
|
43
|
+
],
|
|
75
44
|
})
|
|
76
45
|
```
|
|
77
46
|
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
```md
|
|
81
|
-
---
|
|
82
|
-
layout: home
|
|
83
|
-
title: My Docs
|
|
84
|
-
---
|
|
85
|
-
|
|
86
|
-
# My Docs
|
|
87
|
-
|
|
88
|
-
Welcome to my KawaPress site.
|
|
89
|
-
```
|
|
90
|
-
|
|
91
|
-
Start the development server:
|
|
92
|
-
|
|
93
|
-
```sh
|
|
94
|
-
pnpm exec kawapress dev
|
|
95
|
-
```
|
|
47
|
+
The build stops and names the empty option when one of the four values is missing.
|
|
96
48
|
|
|
97
|
-
|
|
49
|
+
## Options
|
|
98
50
|
|
|
99
|
-
|
|
100
|
-
pnpm exec kawapress build
|
|
101
|
-
```
|
|
102
|
-
|
|
103
|
-
The deployed output is static and does not require a Node.js server. npm and Yarn commands are available in the [Getting Started guide](https://shenqingchuan.github.io/kawapress/en/guide/getting-started).
|
|
104
|
-
|
|
105
|
-
> If your site directly imports Vue APIs or Vue components, also install `vue` as a development dependency.
|
|
106
|
-
|
|
107
|
-
## What You Get
|
|
108
|
-
|
|
109
|
-
| Area | Included capability |
|
|
51
|
+
| Option | Description |
|
|
110
52
|
| --- | --- |
|
|
111
|
-
|
|
|
112
|
-
|
|
|
113
|
-
|
|
|
114
|
-
|
|
|
115
|
-
|
|
|
116
|
-
|
|
|
117
|
-
|
|
|
118
|
-
|
|
119
|
-
The `kawapress` package includes nagi and its official plugins. A basic site only needs this one package; advanced users can compose the individual `@kawapress/*` packages directly.
|
|
120
|
-
|
|
121
|
-
## Extension Model
|
|
122
|
-
|
|
123
|
-
KawaPress keeps extension boundaries explicit:
|
|
124
|
-
|
|
125
|
-
- a **Generator Plugin** extends configuration, Markdown, page data, Vite, and build artifacts;
|
|
126
|
-
- a **Runtime Plugin** extends the real Vue App and Vue Router in both SSR and the browser;
|
|
127
|
-
- a **Preset** combines configuration and plugins into a ready-to-use experience such as nagi.
|
|
128
|
-
|
|
129
|
-
A logical plugin is installed once and can provide both generator and runtime behavior. Learn more in the [Plugin System guide](https://shenqingchuan.github.io/kawapress/en/guide/plugin-system).
|
|
53
|
+
| `giscus.repo / repoId / category / categoryId` | The four values from giscus.app. All are required. |
|
|
54
|
+
| `mapping` | How a page maps to a discussion. Default `pathname`. |
|
|
55
|
+
| `strict` | Match only discussions whose title equals the mapping value. Default off. |
|
|
56
|
+
| `reactionsEnabled` | Show the reaction bar. Default on. |
|
|
57
|
+
| `inputPosition` | `top` or `bottom`. Default `bottom`. |
|
|
58
|
+
| `loading` | `lazy` (default) or `eager`. |
|
|
59
|
+
| `labels / localeLabels` | Change the heading for every language, or for one. |
|
|
130
60
|
|
|
131
61
|
## Documentation
|
|
132
62
|
|
|
133
|
-
|
|
134
|
-
- [What is KawaPress?](https://shenqingchuan.github.io/kawapress/en/guide/what-is-kawapress)
|
|
135
|
-
- [Markdown Extensions](https://shenqingchuan.github.io/kawapress/en/guide/markdown-extensions)
|
|
136
|
-
- [Internationalization](https://shenqingchuan.github.io/kawapress/en/guide/internationalization)
|
|
137
|
-
- [Plugin System](https://shenqingchuan.github.io/kawapress/en/guide/plugin-system)
|
|
138
|
-
- [Theme Customization](https://shenqingchuan.github.io/kawapress/en/guide/theme-customization)
|
|
139
|
-
|
|
140
|
-
## Contributing
|
|
141
|
-
|
|
142
|
-
Issues and pull requests are welcome. For a large feature, please open an issue first so the direction can be agreed on before implementation.
|
|
143
|
-
|
|
144
|
-
```sh
|
|
145
|
-
pnpm install
|
|
146
|
-
pnpm lint
|
|
147
|
-
pnpm typecheck
|
|
148
|
-
pnpm test
|
|
149
|
-
pnpm build
|
|
150
|
-
```
|
|
151
|
-
|
|
152
|
-
KawaPress uses Node.js 22.12 or newer and pnpm 11.22.0 for repository development.
|
|
63
|
+
[Documentation](https://kawapress.dev/en/plugins/comments) · [Report a problem](https://github.com/kawapress/kawapress/issues)
|
|
153
64
|
|
|
154
65
|
## License
|
|
155
66
|
|
|
156
|
-
[MIT](https://github.com/
|
|
67
|
+
[MIT](https://github.com/kawapress/kawapress/blob/main/LICENSE) © KawaPress contributors
|
package/README.zh-CN.md
CHANGED
|
@@ -1,156 +1,67 @@
|
|
|
1
|
-
|
|
2
|
-
<picture>
|
|
3
|
-
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ShenQingchuan/kawapress/main/docs/public/kawapress-logo-dark.png">
|
|
4
|
-
<img src="https://raw.githubusercontent.com/ShenQingchuan/kawapress/main/docs/public/kawapress-logo.png" alt="KawaPress" width="180">
|
|
5
|
-
</picture>
|
|
6
|
-
</p>
|
|
1
|
+
# @kawapress/plugin-comments
|
|
7
2
|
|
|
8
|
-
|
|
3
|
+
KawaPress 的 GitHub Discussions 评论,由 Giscus 驱动。
|
|
9
4
|
|
|
10
|
-
|
|
11
|
-
<strong>以 Vue 为核心,面向文档与内容型网站的静态站点生成器。</strong>
|
|
12
|
-
</p>
|
|
5
|
+
[](https://www.npmjs.com/package/@kawapress/plugin-comments) · [English](https://github.com/kawapress/kawapress/blob/main/packages/plugin-comments/README.md)
|
|
13
6
|
|
|
14
|
-
|
|
15
|
-
用 Markdown 安心写作,在真实 SSR 中开发,通过公开能力自由扩展。
|
|
16
|
-
</p>
|
|
7
|
+
`@kawapress/plugin-comments` 是 [KawaPress](https://github.com/kawapress/kawapress) 的一部分。KawaPress 是一个以 Vue 为核心的静态站点生成器。
|
|
17
8
|
|
|
18
|
-
|
|
19
|
-
<a href="https://www.npmjs.com/package/kawapress"><img src="https://img.shields.io/npm/v/kawapress?label=npm&color=42b883" alt="npm 版本"></a>
|
|
20
|
-
<a href="https://github.com/ShenQingchuan/kawapress/actions/workflows/deploy-pages.yml"><img src="https://github.com/ShenQingchuan/kawapress/actions/workflows/deploy-pages.yml/badge.svg" alt="文档构建状态"></a>
|
|
21
|
-
<a href="https://github.com/ShenQingchuan/kawapress/blob/main/LICENSE"><img src="https://img.shields.io/github/license/ShenQingchuan/kawapress" alt="MIT 许可"></a>
|
|
22
|
-
<img src="https://img.shields.io/badge/Node.js-%E2%89%A522.12-339933?logo=nodedotjs&logoColor=white" alt="Node.js 22.12 或更高版本">
|
|
23
|
-
</p>
|
|
9
|
+
## 特性
|
|
24
10
|
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
11
|
+
- 评论存在 GitHub Discussions 里,站点不需要数据库,也不需要登录系统。
|
|
12
|
+
- 构建时只写入一个标题和一个空容器,评论区快要滚动到视野里时才加载 Giscus 脚本。
|
|
13
|
+
- 评论区跟着站点的浅色/深色外观和界面语言切换。
|
|
14
|
+
- 换到另一个页面会为它重新建一个评论区。
|
|
15
|
+
- 单个页面用 `comments: false` 关闭评论。
|
|
30
16
|
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
## 为什么选择 KawaPress?
|
|
34
|
-
|
|
35
|
-
KawaPress 会把 Markdown 编译成预渲染的 Vue 网站。它保留了文档生成器简单、轻快的写作方式,同时让官方主题和第三方扩展使用完全相同的公开能力。
|
|
36
|
-
|
|
37
|
-
- **开发时也执行真实 SSR**:每次首次请求都会在服务端渲染。只在 SSR 中出现的问题,不必等到构建或上线后才发现。
|
|
38
|
-
- **默认体验完整**:内置 nagi(凪)预设,包含响应式文档布局、深浅色模式、本地搜索、代码高亮、Twoslash、代码组和多语言导航等常用能力。
|
|
39
|
-
- **从头到尾使用 Vue**:Markdown 会变成 Vue 组件,页面跳转交给 Vue Router;需要交互时,也可以自然地使用普通 Vue SFC。
|
|
40
|
-
- **面向 AI 的文档产物**:nagi 默认生成每页 `.md`、各语言的 `llms.txt` 与 `llms-full.txt`,并提供复制正文和链接的操作。
|
|
41
|
-
- **统一的扩展模型**:Generator Plugin、Runtime Plugin 与 Preset 分别覆盖生成阶段、Vue 运行时和能力组合,不依赖主题私有入口。
|
|
42
|
-
|
|
43
|
-
KawaPress 是一个独立项目,不是 VitePress 的分支或配置兼容层,也不能直接使用 VitePress 配置。
|
|
44
|
-
|
|
45
|
-
## 快速开始
|
|
46
|
-
|
|
47
|
-
请先准备 [Node.js](https://nodejs.org/) 22.12 或更高版本。
|
|
48
|
-
|
|
49
|
-
用脚手架创建新站点:
|
|
17
|
+
## 安装
|
|
50
18
|
|
|
51
19
|
```sh
|
|
52
|
-
npm
|
|
53
|
-
cd my-kawapress-site
|
|
54
|
-
npm run dev
|
|
20
|
+
npm install --save-dev @kawapress/plugin-comments
|
|
55
21
|
```
|
|
56
22
|
|
|
57
|
-
`pnpm
|
|
23
|
+
也可以用 `pnpm add --save-dev @kawapress/plugin-comments` 或 `yarn add --dev @kawapress/plugin-comments`。
|
|
58
24
|
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
```sh
|
|
62
|
-
mkdir my-kawapress-site
|
|
63
|
-
cd my-kawapress-site
|
|
64
|
-
pnpm init
|
|
65
|
-
pnpm add --save-dev kawapress
|
|
66
|
-
```
|
|
25
|
+
## 使用
|
|
67
26
|
|
|
68
|
-
|
|
27
|
+
先准备一个开启了 Discussions 的公开仓库,装上 [giscus app](https://github.com/apps/giscus),再从 [giscus.app](https://giscus.app) 复制四个值:
|
|
69
28
|
|
|
70
29
|
```ts
|
|
30
|
+
import commentsPlugin from '@kawapress/plugin-comments'
|
|
71
31
|
import { nagi } from 'kawapress/nagi'
|
|
72
32
|
|
|
73
33
|
export default nagi({
|
|
74
|
-
|
|
34
|
+
plugins: [
|
|
35
|
+
commentsPlugin({
|
|
36
|
+
giscus: {
|
|
37
|
+
repo: 'your-name/your-repo',
|
|
38
|
+
repoId: 'R_kgDOxxxxxxx',
|
|
39
|
+
category: 'Comments',
|
|
40
|
+
categoryId: 'DIC_kwDOxxxxxxx',
|
|
41
|
+
},
|
|
42
|
+
}),
|
|
43
|
+
],
|
|
75
44
|
})
|
|
76
45
|
```
|
|
77
46
|
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
```md
|
|
81
|
-
---
|
|
82
|
-
layout: home
|
|
83
|
-
title: My Docs
|
|
84
|
-
---
|
|
85
|
-
|
|
86
|
-
# My Docs
|
|
87
|
-
|
|
88
|
-
欢迎来到我的 KawaPress 站点。
|
|
89
|
-
```
|
|
90
|
-
|
|
91
|
-
启动开发服务器:
|
|
92
|
-
|
|
93
|
-
```sh
|
|
94
|
-
pnpm exec kawapress dev
|
|
95
|
-
```
|
|
47
|
+
四个值缺任何一个,构建都会停下来,并指出是哪个选项为空。
|
|
96
48
|
|
|
97
|
-
|
|
49
|
+
## 配置项
|
|
98
50
|
|
|
99
|
-
|
|
100
|
-
pnpm exec kawapress build
|
|
101
|
-
```
|
|
102
|
-
|
|
103
|
-
部署产物是普通静态文件,不需要在服务器上继续运行 Node.js。npm 和 Yarn 的完整命令可以查看[快速开始](https://shenqingchuan.github.io/kawapress/guide/getting-started)。
|
|
104
|
-
|
|
105
|
-
> 如果站点会直接导入 Vue API 或 Vue 组件,还需要把 `vue` 安装为开发依赖。
|
|
106
|
-
|
|
107
|
-
## 默认包含什么?
|
|
108
|
-
|
|
109
|
-
| 范围 | 内置能力 |
|
|
51
|
+
| 选项 | 说明 |
|
|
110
52
|
| --- | --- |
|
|
111
|
-
|
|
|
112
|
-
|
|
|
113
|
-
|
|
|
114
|
-
|
|
|
115
|
-
|
|
|
116
|
-
|
|
|
117
|
-
|
|
|
118
|
-
|
|
119
|
-
`kawapress` 已经包含 nagi 和它使用的官方插件。普通文档站只需要安装这一个包;需要自行组合能力时,也可以直接使用独立的 `@kawapress/*` 包。
|
|
120
|
-
|
|
121
|
-
## 扩展模型
|
|
122
|
-
|
|
123
|
-
KawaPress 把扩展边界分得很清楚:
|
|
124
|
-
|
|
125
|
-
- **Generator Plugin** 负责配置、Markdown、页面数据、Vite 与构建产物;
|
|
126
|
-
- **Runtime Plugin** 在 SSR 和浏览器中扩展真实的 Vue App 与 Vue Router;
|
|
127
|
-
- **Preset** 把配置和一组插件组合成可以直接使用的产品体验,例如 nagi。
|
|
128
|
-
|
|
129
|
-
一个逻辑插件只需要安装一次,同时可以提供生成侧和运行侧能力。更多内容请查看[插件体系](https://shenqingchuan.github.io/kawapress/guide/plugin-system)。
|
|
53
|
+
| `giscus.repo / repoId / category / categoryId` | 来自 giscus.app 的四个值,都必须填写。 |
|
|
54
|
+
| `mapping` | 页面怎样对应到一个讨论,默认 `pathname`。 |
|
|
55
|
+
| `strict` | 只匹配标题与映射值完全相同的讨论,默认关闭。 |
|
|
56
|
+
| `reactionsEnabled` | 显示表情回应栏,默认开启。 |
|
|
57
|
+
| `inputPosition` | `top` 或 `bottom`,默认 `bottom`。 |
|
|
58
|
+
| `loading` | `lazy`(默认)或 `eager`。 |
|
|
59
|
+
| `labels / localeLabels` | 改写所有语言或某一种语言的标题。 |
|
|
130
60
|
|
|
131
61
|
## 文档
|
|
132
62
|
|
|
133
|
-
|
|
134
|
-
- [KawaPress 是什么?](https://shenqingchuan.github.io/kawapress/guide/what-is-kawapress)
|
|
135
|
-
- [Markdown 语法扩展](https://shenqingchuan.github.io/kawapress/guide/markdown-extensions)
|
|
136
|
-
- [国际化](https://shenqingchuan.github.io/kawapress/guide/internationalization)
|
|
137
|
-
- [插件体系](https://shenqingchuan.github.io/kawapress/guide/plugin-system)
|
|
138
|
-
- [主题定制](https://shenqingchuan.github.io/kawapress/guide/theme-customization)
|
|
139
|
-
|
|
140
|
-
## 参与贡献
|
|
141
|
-
|
|
142
|
-
欢迎提交 Issue 和 Pull Request。如果准备增加较大的功能,请先创建 Issue,把目标和方案聊清楚后再开始实现。
|
|
143
|
-
|
|
144
|
-
```sh
|
|
145
|
-
pnpm install
|
|
146
|
-
pnpm lint
|
|
147
|
-
pnpm typecheck
|
|
148
|
-
pnpm test
|
|
149
|
-
pnpm build
|
|
150
|
-
```
|
|
151
|
-
|
|
152
|
-
KawaPress 仓库使用 Node.js 22.12 或更高版本,以及 pnpm 11.22.0 进行开发。
|
|
63
|
+
[文档](https://kawapress.dev/plugins/comments) · [反馈问题](https://github.com/kawapress/kawapress/issues)
|
|
153
64
|
|
|
154
|
-
##
|
|
65
|
+
## 许可证
|
|
155
66
|
|
|
156
|
-
[MIT](https://github.com/
|
|
67
|
+
[MIT](https://github.com/kawapress/kawapress/blob/main/LICENSE) © KawaPress contributors
|
package/package.json
CHANGED
|
@@ -1,17 +1,17 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kawapress/plugin-comments",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "0.1
|
|
4
|
+
"version": "0.2.1",
|
|
5
5
|
"description": "GitHub Discussions comments for KawaPress, powered by Giscus",
|
|
6
6
|
"license": "MIT",
|
|
7
|
-
"homepage": "https://
|
|
7
|
+
"homepage": "https://kawapress.dev/",
|
|
8
8
|
"repository": {
|
|
9
9
|
"type": "git",
|
|
10
|
-
"url": "git+https://github.com/
|
|
10
|
+
"url": "git+https://github.com/kawapress/kawapress.git",
|
|
11
11
|
"directory": "packages/plugin-comments"
|
|
12
12
|
},
|
|
13
13
|
"bugs": {
|
|
14
|
-
"url": "https://github.com/
|
|
14
|
+
"url": "https://github.com/kawapress/kawapress/issues"
|
|
15
15
|
},
|
|
16
16
|
"exports": {
|
|
17
17
|
".": {
|
|
@@ -38,12 +38,12 @@
|
|
|
38
38
|
},
|
|
39
39
|
"peerDependencies": {
|
|
40
40
|
"vue": "^3.5.41",
|
|
41
|
-
"kawapress": "0.1
|
|
41
|
+
"kawapress": "^0.2.1"
|
|
42
42
|
},
|
|
43
43
|
"devDependencies": {
|
|
44
44
|
"happy-dom": "^20.11.6",
|
|
45
45
|
"vite": "^8.2.2",
|
|
46
46
|
"vue": "^3.5.41",
|
|
47
|
-
"kawapress": "0.1
|
|
47
|
+
"kawapress": "0.2.1"
|
|
48
48
|
}
|
|
49
49
|
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Frontmatter keys this plugin reads. Every reader of `PageFrontmatter` sees
|
|
3
|
+
* them while the plugin is imported.
|
|
4
|
+
*/
|
|
5
|
+
declare module 'kawapress' {
|
|
6
|
+
interface PageFrontmatter {
|
|
7
|
+
/** `false` hides the comment section of this page. */
|
|
8
|
+
comments?: boolean
|
|
9
|
+
}
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
export {}
|
package/src/index.ts
CHANGED
|
@@ -3,6 +3,7 @@ import type { CommentsPluginOptions } from './options'
|
|
|
3
3
|
import { definePlugin } from 'kawapress'
|
|
4
4
|
import { resolveCommentsOptions } from './options'
|
|
5
5
|
import { commentsOptionsPlugin } from './vite-plugin'
|
|
6
|
+
import './frontmatter'
|
|
6
7
|
|
|
7
8
|
export const COMMENTS_PLUGIN_NAME = '@kawapress/plugin-comments'
|
|
8
9
|
|