Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/halo-sigs/plugin-moments

适用于 Halo 2.0 的瞬间插件
https://github.com/halo-sigs/plugin-moments

halo halo-plugin

Last synced: 1 day ago
JSON representation

适用于 Halo 2.0 的瞬间插件

Host: GitHub
URL: https://github.com/halo-sigs/plugin-moments
Owner: halo-sigs
License: gpl-3.0
Created: 2022-06-27T06:37:05.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-10-21T09:29:19.000Z (14 days ago)
Last Synced: 2024-10-21T13:32:57.775Z (13 days ago)
Topics: halo, halo-plugin
Language: TypeScript
Homepage: https://halo.run/store/apps/app-SnwWD
Size: 6.21 MB
Stars: 40
Watchers: 3
Forks: 14
Open Issues: 15
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-halo - plugin-moments - Halo 2.0 的瞬间管理插件 (Halo 2.0 / 插件)

README

# plugin-moments

Halo 2.0 的瞬间管理插件，提供一个轻量级的内容发布功能，支持发布图文、视频、音频等内容。

![Preview](./images/plugin-moments-preview.png)

## 使用方式

1. 下载，目前提供以下两个下载方式：
- Halo 应用市场：
- GitHub Releases：访问 [Releases](https://github.com/halo-sigs/plugin-moments/releases) 下载 Assets 中的 JAR 文件。
2. 安装，插件安装和更新方式可参考：
3. 安装完成之后，访问 Console 左侧的**瞬间**菜单项，即可进行管理。
4. 前台访问地址为 `/moments`，需要注意的是，此插件需要主题提供模板（moments.html）才能访问 `/moments`。
5. 此插件也提供了 RSS 订阅的路由，可以访问 `/moments/rss.xml`。
6. 此插件将数据同步至 Halo 搜索，type 为 `moment.moment.halo.run`。

## 开发环境

插件开发的详细文档请查阅：

所需环境：

1. Java 17
2. Node 18
3. pnpm 8
4. Docker (可选)

克隆项目：

```bash
git clone [email protected]:halo-sigs/plugin-moments.git

# 或者当你 fork 之后

git clone [email protected]:{your_github_id}/plugin-moments.git
```

```bash
cd path/to/plugin-moments
```

### 运行方式 1（推荐）

> 此方式需要本地安装 Docker

```bash
# macOS / Linux
./gradlew pnpmInstall

# Windows
./gradlew.bat pnpmInstall
```

```bash
# macOS / Linux
./gradlew haloServer

# Windows
./gradlew.bat haloServer
```

执行此命令后，会自动创建一个 Halo 的 Docker 容器并加载当前的插件，更多文档可查阅：

### 运行方式 2

> 此方式需要使用源码运行 Halo

编译插件：

```bash
# macOS / Linux
./gradlew build

# Windows
./gradlew.bat build
```

修改 Halo 配置文件：

```yaml
halo:
plugin:
runtime-mode: development
fixedPluginPath:
- "/path/to/plugin-moments"
```

最后重启 Halo 项目即可。

## 主题适配

目前此插件为主题端提供了 `/moments` 路由，模板为 `moments.html`，也提供了 [Finder API](https://docs.halo.run/developer-guide/theme/finder-apis)，可以将瞬间列表渲染到任何地方。

### 模板变量

#### 列表页面 /moments

- 模板路径：/templates/moments.html
- 访问路径：/moments?tag={tag} | moments/page/{page}?tag={tag}

**参数**：

- tag：标签名称，用于筛选。

**变量**：

- moments：[#UrlContextListResult\](#urlcontextlistresult-momentvo)
- tags：[#List\](#momenttagvo)

**示例**：

```html

```

#### 详情页面 /moments/{name}

- 模板路径：/templates/moment.html
- 访问路径：/moments/{name}

**变量**：

- moment：[#MomentVo](#momentvo)

**示例**：

```html

```

#### 搜索路由

**变量**：

- type: moment.moment.halo.run

### Finder API

#### listAll()

获取全部瞬间内容。

**返回值类型**：List<[#MomentVo](#momentvo)>

**示例**：

```html

```

#### list(page, size)

根据分页参数获取瞬间列表。

**参数**：

1. `page: int` - 分页页码，从 1 开始
2. `size: int` - 分页条数

**返回值类型**：[ListResult\](#listresult-momentvo)

**示例**：

```html

```

### 类型定义

#### MomentVo

```json
{
"metadata": {
"name": "string", // 唯一标识
"labels": {
"additionalProp1": "string"
},
"annotations": {
"additionalProp1": "string"
},
"creationTimestamp": "2022-11-20T13:06:38.512Z" // 创建时间
},
"spec": {
"content": {
"raw": "string", // 原始内容，一般用于编辑器使用
"html": "string", // HTML 内容，用于主题端进行最终渲染的内容
"medium": [
// 媒体内容
{
"type": "#MomentMediaType", // 类型
"url": "string", // 链接
"originType": "string" // 原始类型，例如：image/jpeg
}
]
},
"releaseTime": "string", // 发布时间
"visible": "PUBLIC", // 可见性
"owner": "string", // 所属用户
"tags": ["string"] // 所拥有的标签
},
"owner": {
"name": "string", // 用户名
"avatar": "string", // 头像
"bio": "string", // 描述
"displayName": "string" // 显示名称
},
"stats": {
"upvote": 0, // 点赞数
"totalComment": 0, // 评论数
"approvedComment": 0 // 审核通过的评论数
}
}
```

#### MomentMediaType

```java
enum Target {
PHOTO, // 图片
VIDEO, // 视频
POST, // 文章
AUDIO; // 音频
}
```

#### ListResult

```json
{
"page": 0, // 当前页码
"size": 0, // 每页条数
"total": 0, // 总条数
"items": "List<#MomentVo>", // 瞬间列表数据
"first": true, // 是否为第一页
"last": true, // 是否为最后一页
"hasNext": true, // 是否有下一页
"hasPrevious": true, // 是否有上一页
"totalPages": 0 // 总页数
}
```

#### UrlContextListResult

#### MomentTagVo

```json
{
"name": "string", // 标签名称
"momentCount": 0 // 标签所属的 moment 数量
}
```