Deploy to GitHub pages

Zuoqiu-Yingyi · Jun 21, 2023 · 2e98e54 · 2e98e54
commit 2e98e54
Show file tree

Hide file tree

Showing 8 changed files with 321 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,102 @@
+<div align="center">
+<img alt="icon" src="https://cdn.jsdelivr.net/gh/Zuoqiu-Yingyi/widget-metadata/public/icon.png" style="width: 8em; height: 8em;">
+
+---
+[![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/Zuoqiu-Yingyi/widget-metadata?include_prereleases&style=flat-square)](https://github.com/Zuoqiu-Yingyi/widget-metadata/releases/latest)
+[![GitHub Release Date](https://img.shields.io/github/release-date/Zuoqiu-Yingyi/widget-metadata?style=flat-square)](https://github.com/Zuoqiu-Yingyi/widget-metadata/releases/latest)
+[![GitHub License](https://img.shields.io/github/license/Zuoqiu-Yingyi/widget-metadata?style=flat-square)](https://github.com/Zuoqiu-Yingyi/widget-metadata/blob/main/LICENSE)
+[![GitHub last commit](https://img.shields.io/github/last-commit/Zuoqiu-Yingyi/widget-metadata?style=flat-square)](https://github.com/Zuoqiu-Yingyi/widget-metadata/commits/main)
+![GitHub repo size](https://img.shields.io/github/repo-size/Zuoqiu-Yingyi/widget-metadata?style=flat-square)
+![hits](https://hits.b3log.org/Zuoqiu-Yingyi/widget-metadata.svg)
+[![GitHub all releases](https://img.shields.io/github/downloads/Zuoqiu-Yingyi/widget-metadata/total?style=flat-square)](https://github.com/Zuoqiu-Yingyi/widget-metadata/releases)
+
+---
+[简体中文](./README_zh_CN.md) \| English
+
+---
+</div>
+
+# Document Metadata
+
+A Widget of document block metadata for [SiYuan Note](https://github.com/siyuan-note/siyuan).
+
+## PREVIEW
+
+![preview](https://cdn.jsdelivr.net/gh/Zuoqiu-Yingyi/widget-metadata/public/preview.png)  
+
+## FUNCTIONAL DESCRIPTION
+
+- Edit the basic attributes of document block.
+  - `created`
+    - Document Creation Time
+  - `updated`
+    - Document Modification Time
+  - `title`
+    - Document Title
+  - `name`
+    - Document Name
+  - `alias`
+    - Document Alias
+  - `tags`
+    - Document Tags
+  - `bookmark`
+    - Document Bookmark
+  - `memo`
+    - Document Memo
+- Edit the custom attributes of document block.
+  - `custom-*`
+    - Custom attribute name can contain only `a-z`, `A-Z`, `0-9`, `-`
+    - Delete the custom attribute when the attribute value is empty.
+- Edit the custom attributes of document block.
+  - `id`
+    - Document Identification
+  - `icon`
+    - Document Icon
+  - `scroll`
+    - Document Browse Location
+  - `title-img`
+    - Document Cover Image
+- Export metadata for document blocks to YAML Front Matter (YFM)
+  - You can select partial attributes to export.
+  - You can rename the attributes on export.
+  - You can sort the attributes on export.
+  - You can preview the exported content.
+  - You can select the parser of custom attributes value.
+    - `string`
+      - Parse as string
+    - `JSON`
+      - Parse as JSON object
+      - Valid value
+        - `JSON` string
+        - `JSON5` string
+        - `JavaScript Object`
+        - `JavaScript` self-executing function
+    - `YAML`
+      - Parse as YAML object
+      - Valid value
+        - `YAML` string
+        - `JSON` string
+
+
+## START
+
+The widget has been put on the shelves at [SiYuan community bazaar](https://github.com/siyuan-note/bazaar) and can be installed directly in the Bazaar.
+
+## REFERENCE & THANKS
+
+## DEPENDENCIES
+
+| Author                                            | Project                                                                                                                   | License                                                                           |
+| :------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------ | :-------------------------------------------------------------------------------- |
+| **[vitejs](https://github.com/vitejs)**           | [vitejs/vite: Next generation frontend tooling. It's fast!](https://github.com/vitejs/vite)                               | *[MIT license](https://github.com/vitejs/vite/blob/main/LICENSE)*                 |
+| **[vuejs](https://github.com/vuejs)**             | [vuejs/vue: This is the repo for Vue 2. For Vue 3, go to https://github.com/vuejs/core](https://github.com/vuejs/vue)     | *[MIT license](https://github.com/vuejs/vue/blob/main/LICENSE)*                   |
+| **[kazupon](https://github.com/kazupon)**         | [kazupon/vue-i18n: Internationalization plugin for Vue.js](https://github.com/kazupon/vue-i18n)                           | *[MIT license](https://github.com/kazupon/vue-i18n/blob/v8.x/LICENSE)*            |
+| **[arco-design](https://github.com/arco-design)** | [arco-design/arco-design-vue: A Vue.js 3 UI Library based on Arco Design](https://github.com/arco-design/arco-design-vue) | *[MIT license](https://github.com/arco-design/arco-design-vue/blob/main/LICENSE)* |
+| **[moment](https://github.com/moment)**           | [GitHub - moment/moment: Parse, validate, manipulate, and display dates in javascript.](https://github.com/moment/moment) | *[MIT license](https://github.com/moment/moment/blob/develop/LICENSE)*            |
+
+
+ps: Sort by introduction time.
+
+## CHANGE LOGS
+
+[CHANGELOG.md](https://github.com/Zuoqiu-Yingyi/widget-metadata/blob/main/CHANGELOG.md)
diff --git a/README_zh_CN.md b/README_zh_CN.md
@@ -0,0 +1,102 @@
+<div align="center">
+<img alt="图标" src="https://cdn.jsdelivr.net/gh/Zuoqiu-Yingyi/widget-metadata/public/icon.png" style="width: 8em; height: 8em;">
+
+---
+[![GitHub 最新发行版本 (最新一次发行/预发行)](https://img.shields.io/github/v/release/Zuoqiu-Yingyi/widget-metadata?include_prereleases&style=flat-square)](https://github.com/Zuoqiu-Yingyi/widget-metadata/releases/latest)
+[![GitHub 最新发行时间](https://img.shields.io/github/release-date/Zuoqiu-Yingyi/widget-metadata?style=flat-square)](https://github.com/Zuoqiu-Yingyi/widget-metadata/releases/latest)
+[![GitHub 许可证](https://img.shields.io/github/license/Zuoqiu-Yingyi/widget-metadata?style=flat-square)](https://github.com/Zuoqiu-Yingyi/widget-metadata/blob/main/LICENSE)
+[![GitHub 最后一次提交时间](https://img.shields.io/github/last-commit/Zuoqiu-Yingyi/widget-metadata?style=flat-square)](https://github.com/Zuoqiu-Yingyi/widget-metadata/commits/main)
+![GitHub 仓库大小](https://img.shields.io/github/repo-size/Zuoqiu-Yingyi/widget-metadata?style=flat-square)
+![查看次数](https://hits.b3log.org/Zuoqiu-Yingyi/widget-metadata.svg)
+[![GitHub 发行版本下载次数](https://img.shields.io/github/downloads/Zuoqiu-Yingyi/widget-metadata/total?style=flat-square)](https://github.com/Zuoqiu-Yingyi/widget-metadata/releases)
+
+---
+简体中文 \| [English](./README.md)
+
+---
+</div>
+
+# 文档元数据
+
+一个适用于 [思源笔记](https://github.com/siyuan-note/siyuan) 的文档块元数据挂件
+
+## 预览
+
+![预览](https://cdn.jsdelivr.net/gh/Zuoqiu-Yingyi/widget-metadata/public/preview.png)
+
+## 功能介绍
+
+- 编辑文档块的基本属性
+  - `created`
+    - 文档创建时间
+  - `updated`
+    - 文档修改时间
+  - `title`
+    - 文档标题
+  - `name`
+    - 文档命名
+  - `alias`
+    - 文档别名
+  - `tags`
+    - 文档标签
+  - `bookmark`
+    - 文档书签
+  - `memo`
+    - 文档备注
+- 编辑文档块的自定义属性
+  - `custom-*`
+    - 自定义属性名仅能包含 `a-z`, `A-Z`, `0-9`, `-`
+    - 自定义属性值为空时删除该属性
+- 编辑文档块的其他属性
+  - `id`
+    - 文档标识
+  - `icon`
+    - 文档图标
+  - `scroll`
+    - 文档浏览位置
+  - `title-img`
+    - 文档题头图
+- 导出文档块的元数据为 YAML Front Matter (YFM)
+  - 可选择部分属性导出
+  - 可在导出时重命名属性
+  - 可在导出时对属性排序
+  - 可预览导出的内容
+  - 可选择自定义属性值的解析器
+    - `string`
+      - 解析为字符串
+    - `JSON`
+      - 解析为 JSON 对象
+      - 有效值
+        - `JSON` 字符串
+        - `JSON5` 字符串
+        - `JavaScript Object`
+        - `JavaScript` 自执行函数
+    - `YAML`
+      - 解析为 YAML 对象
+      - 有效值
+        - `YAML` 字符串
+        - `JSON` 字符串
+
+
+## 开始
+
+该挂件已在[思源笔记社区集市](https://github.com/siyuan-note/bazaar)上架, 可直接在集市中安装
+
+## 参考 & 感谢
+
+## 依赖
+
+| 作者                                              | 项目                                                                                                                      | 许可证                                                                            |
+| :------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------ | :-------------------------------------------------------------------------------- |
+| **[vitejs](https://github.com/vitejs)**           | [vitejs/vite: Next generation frontend tooling. It's fast!](https://github.com/vitejs/vite)                               | *[MIT license](https://github.com/vitejs/vite/blob/main/LICENSE)*                 |
+| **[vuejs](https://github.com/vuejs)**             | [vuejs/vue: This is the repo for Vue 2. For Vue 3, go to https://github.com/vuejs/core](https://github.com/vuejs/vue)     | *[MIT license](https://github.com/vuejs/vue/blob/main/LICENSE)*                   |
+| **[kazupon](https://github.com/kazupon)**         | [kazupon/vue-i18n: Internationalization plugin for Vue.js](https://github.com/kazupon/vue-i18n)                           | *[MIT license](https://github.com/kazupon/vue-i18n/blob/v8.x/LICENSE)*            |
+| **[arco-design](https://github.com/arco-design)** | [arco-design/arco-design-vue: A Vue.js 3 UI Library based on Arco Design](https://github.com/arco-design/arco-design-vue) | *[MIT license](https://github.com/arco-design/arco-design-vue/blob/main/LICENSE)* |
+| **[moment](https://github.com/moment)**           | [GitHub - moment/moment: Parse, validate, manipulate, and display dates in javascript.](https://github.com/moment/moment) | *[MIT license](https://github.com/moment/moment/blob/develop/LICENSE)*            |
+
+
+注: 按引入时间排序
+
+## 更改日志
+
+[CHANGELOG.md](https://github.com/Zuoqiu-Yingyi/widget-metadata/blob/main/CHANGELOG.md)
diff --git a/assets/index-43c3b82e.css b/assets/index-43c3b82e.css
diff --git a/assets/index-4a6748c4.js b/assets/index-4a6748c4.js
diff --git a/icon.png b/icon.png
diff --git a/index.html b/index.html
@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+
+<head>
+  <meta charset="UTF-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Metadata</title>
+
+  <script async type="module" crossorigin src="./assets/index-4a6748c4.js"></script>
+  <link rel="stylesheet" href="./assets/index-43c3b82e.css">
+</head>
+
+<body></body>
+
+</html>
diff --git a/preview.png b/preview.png
diff --git a/widget.json b/widget.json
@@ -0,0 +1,30 @@
+{
+    "name": "metadata",
+    "author": "Zuoqiu-Yingyi",
+    "url": "https://github.com/Zuoqiu-Yingyi/widget-metadata",
+    "version": "1.0.0",
+    "displayName": {
+        "default": "Document Metadata",
+        "zh_CN": "文档元数据",
+        "zh_CHT": "文檔元數據"
+    },
+    "description": {
+        "default": "Manage block attributes for SiYuan document blocks and can also be used to customize YAML Front Matter (YFM) metadata when exported.",
+        "zh_CN": "管理思源文档块的块属性，也可用于自定义导出时的 YAML Front Matter (YFM) 元数据。",
+        "zh_CHT": "管理思源文件塊的塊屬性，也可用於自定義匯出時的 YAML Front Matter (YFM) 元數據。"
+    },
+    "readme": {
+        "default": "README.md",
+        "zh_CN": "README_zh_CN.md",
+        "zh_CHT": "README_zh_CN.md"
+    },
+    "funding": {
+        "openCollective": "",
+        "patreon": "",
+        "github": "",
+        "custom": [
+            "https://afdian.net/a/zuoqiu",
+            "https://ko-fi.com/zuoqiu"
+        ]
+    }
+}