Skip to content

Commit cf73928

Browse files
author
ZCode Marketplace Bot
committed
feat(plugins): add Obsidian authoring and visualization skills
Source-Commit: 15f1d7f2d52da94d62b54e518bad5b896a62d8ed
1 parent cb1ef37 commit cf73928

29 files changed

Lines changed: 4757 additions & 0 deletions

File tree

‎assets/icon-sources.json‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1327,6 +1327,16 @@
13271327
"mimeType": "image/png",
13281328
"sha256": "29a6ede33f370301db496f40170c0afa585f6a4d5a8c68c372fd83e2d441606f"
13291329
},
1330+
{
1331+
"name": "obsidian",
1332+
"icon": "obsidian/icon.png",
1333+
"source": "https://obsidian.md/favicon.svg",
1334+
"matchedBy": "official-homepage-favicon-svg-converted-padded",
1335+
"homepage": "https://obsidian.md",
1336+
"mimeType": "image/png",
1337+
"sha256": "6e4b6881c3e3c304cbcaa53ffb202aa68fece3a0082a451f1638ff2c730a1285",
1338+
"transform": "Render SVG at 216x216 centered on a transparent 256x256 canvas (20px padding)."
1339+
},
13301340
{
13311341
"name": "oracle-ai-data-platform-workbench-databricks-migrator",
13321342
"icon": "oracle-ai-data-platform-workbench-databricks-migrator/icon.png",

‎assets/obsidian/icon.png‎

9.06 KB
Loading

‎marketplace.json‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -707,6 +707,39 @@
707707
"source": "./plugins/finance-search",
708708
"category": "finance",
709709
"icon": "https://cdn-zcode.z.ai/zcode/official-plugin/assets/finance-search/icon.png"
710+
},
711+
{
712+
"name": "obsidian",
713+
"displayName": "Obsidian",
714+
"displayName_i18n": {
715+
"en": "Obsidian",
716+
"zh-CN": "Obsidian"
717+
},
718+
"source": "./plugins/obsidian",
719+
"description": "Obsidian authoring skills from kepano/obsidian-skills: Obsidian Flavored Markdown notes, Bases database views, JSON Canvas boards, vault automation via Obsidian CLI, clean web extraction with Defuddle, and Knap template rendering — plus visualization skills from axtonliu/axton-obsidian-visual-skills: Mermaid and Excalidraw diagram generation and text-to-canvas layout. A setup skill verifies and installs the Obsidian CLI, defuddle, and knap.",
720+
"description_i18n": {
721+
"en": "Obsidian authoring skills from kepano/obsidian-skills: Obsidian Flavored Markdown notes, Bases database views, JSON Canvas boards, vault automation via Obsidian CLI, clean web extraction with Defuddle, and Knap template rendering — plus visualization skills from axtonliu/axton-obsidian-visual-skills: Mermaid and Excalidraw diagram generation and text-to-canvas layout. A setup skill verifies and installs the Obsidian CLI, defuddle, and knap.",
722+
"zh-CN": "来自 kepano/obsidian-skills 的 Obsidian 创作技能：Obsidian 风格 Markdown 笔记、Bases 数据库视图、JSON Canvas 白板、Obsidian CLI 库操作、Defuddle 网页正文提取、Knap 模板批量生成笔记；并集成 axtonliu/axton-obsidian-visual-skills 的可视化技能：Mermaid/Excalidraw 图表生成与文本转画布布局。附 setup 技能，检测并安装 Obsidian CLI、defuddle 与 knap。"
723+
},
724+
"version": "0.1.2",
725+
"author": {
726+
"name": "Z.ai",
727+
"url": "https://z.ai"
728+
},
729+
"category": "productivity",
730+
"keywords": [
731+
"obsidian",
732+
"markdown",
733+
"bases",
734+
"canvas",
735+
"notes",
736+
"defuddle",
737+
"knap",
738+
"mermaid",
739+
"excalidraw",
740+
"visualization"
741+
],
742+
"icon": "https://cdn-zcode.z.ai/zcode/official-plugin/assets/obsidian/icon.png"
710743
}
711744
]
712745
}

‎plugins/obsidian/.claude-plugin/plugin.json‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
{
2+
"name": "obsidian",
3+
"version": "0.1.2",
4+
"description": "Obsidian authoring skills from kepano/obsidian-skills: Obsidian Flavored Markdown notes, Bases database views, JSON Canvas boards, vault automation via Obsidian CLI, clean web extraction with Defuddle, and Knap template rendering — plus visualization skills from axtonliu/axton-obsidian-visual-skills: Mermaid and Excalidraw diagram generation and text-to-canvas layout. A setup skill verifies and installs the Obsidian CLI, defuddle, and knap.",
5+
"description_i18n": {
6+
"en": "Obsidian authoring skills from kepano/obsidian-skills: Obsidian Flavored Markdown notes, Bases database views, JSON Canvas boards, vault automation via Obsidian CLI, clean web extraction with Defuddle, and Knap template rendering — plus visualization skills from axtonliu/axton-obsidian-visual-skills: Mermaid and Excalidraw diagram generation and text-to-canvas layout. A setup skill verifies and installs the Obsidian CLI, defuddle, and knap.",
7+
"zh-CN": "来自 kepano/obsidian-skills 的 Obsidian 创作技能：Obsidian 风格 Markdown 笔记、Bases 数据库视图、JSON Canvas 白板、Obsidian CLI 库操作、Defuddle 网页正文提取、Knap 模板批量生成笔记；并集成 axtonliu/axton-obsidian-visual-skills 的可视化技能：Mermaid/Excalidraw 图表生成与文本转画布布局。附 setup 技能，检测并安装 Obsidian CLI、defuddle 与 knap。"
8+
},
9+
"author": {
10+
"name": "Z.ai",
11+
"url": "https://z.ai"
12+
},
13+
"license": "MIT",
14+
"keywords": [
15+
"obsidian",
16+
"markdown",
17+
"bases",
18+
"canvas",
19+
"notes",
20+
"defuddle",
21+
"knap",
22+
"mermaid",
23+
"excalidraw",
24+
"visualization"
25+
]
26+
}

‎plugins/obsidian/.zcode-plugin/plugin.json‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
{
2+
"name": "obsidian",
3+
"version": "0.1.2",
4+
"description": "Obsidian authoring skills from kepano/obsidian-skills: Obsidian Flavored Markdown notes, Bases database views, JSON Canvas boards, vault automation via Obsidian CLI, clean web extraction with Defuddle, and Knap template rendering — plus visualization skills from axtonliu/axton-obsidian-visual-skills: Mermaid and Excalidraw diagram generation and text-to-canvas layout. A setup skill verifies and installs the Obsidian CLI, defuddle, and knap.",
5+
"description_i18n": {
6+
"en": "Obsidian authoring skills from kepano/obsidian-skills: Obsidian Flavored Markdown notes, Bases database views, JSON Canvas boards, vault automation via Obsidian CLI, clean web extraction with Defuddle, and Knap template rendering — plus visualization skills from axtonliu/axton-obsidian-visual-skills: Mermaid and Excalidraw diagram generation and text-to-canvas layout. A setup skill verifies and installs the Obsidian CLI, defuddle, and knap.",
7+
"zh-CN": "来自 kepano/obsidian-skills 的 Obsidian 创作技能：Obsidian 风格 Markdown 笔记、Bases 数据库视图、JSON Canvas 白板、Obsidian CLI 库操作、Defuddle 网页正文提取、Knap 模板批量生成笔记；并集成 axtonliu/axton-obsidian-visual-skills 的可视化技能：Mermaid/Excalidraw 图表生成与文本转画布布局。附 setup 技能，检测并安装 Obsidian CLI、defuddle 与 knap。"
8+
},
9+
"author": {
10+
"name": "Z.ai",
11+
"url": "https://z.ai"
12+
},
13+
"license": "MIT",
14+
"keywords": [
15+
"obsidian",
16+
"markdown",
17+
"bases",
18+
"canvas",
19+
"notes",
20+
"defuddle",
21+
"knap",
22+
"mermaid",
23+
"excalidraw",
24+
"visualization"
25+
]
26+
}

‎plugins/obsidian/LICENSE‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
This plugin aggregates skills from two MIT-licensed upstream projects, plus
2+
local additions. The copyright and license notices for each source follow.
3+
4+
================================================================================
5+
1. Components from https://github.com/kepano/obsidian-skills
6+
(skills/obsidian-markdown, skills/obsidian-bases, skills/json-canvas,
7+
skills/obsidian-cli, skills/defuddle, skills/knap, and their references/)
8+
9+
MIT License
10+
11+
Copyright (c) 2026 Steph Ango (@kepano)
12+
13+
Permission is hereby granted, free of charge, to any person obtaining a copy
14+
of this software and associated documentation files (the "Software"), to deal
15+
in the Software without restriction, including without limitation the rights
16+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
17+
copies of the Software, and to permit persons to whom the Software is
18+
furnished to do so, subject to the following conditions:
19+
20+
The above copyright notice and this permission notice shall be included in all
21+
copies or substantial portions of the Software.
22+
23+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
24+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
26+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
28+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29+
SOFTWARE.
30+
31+
================================================================================
32+
2. Components from https://github.com/axtonliu/axton-obsidian-visual-skills
33+
(skills/mermaid-visualizer, skills/excalidraw-diagram, and the layout
34+
algorithms and canvas templates folded into skills/json-canvas/)
35+
36+
MIT License
37+
38+
Copyright (c) 2025 Axton Liu
39+
40+
Permission is hereby granted, free of charge, to any person obtaining a copy
41+
of this software and associated documentation files (the "Software"), to deal
42+
in the Software without restriction, including without limitation the rights
43+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
44+
copies of the Software, and to permit persons to whom the Software is
45+
furnished to do so, subject to the following conditions:
46+
47+
The above copyright notice and this permission notice shall be included in all
48+
copies or substantial portions of the Software.
49+
50+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
51+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
52+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
53+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
54+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
55+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
56+
SOFTWARE.
57+
58+
================================================================================
59+
3. Local additions with no upstream counterpart
60+
(the .zcode-plugin/ and .claude-plugin/ manifests, README.md,
61+
README_CN.md, UPSTREAM.md, and skills/setup/)
62+
63+
MIT License
64+
65+
Copyright (c) 2026 Z.ai
66+
67+
Permission is hereby granted, free of charge, to any person obtaining a copy
68+
of this software and associated documentation files (the "Software"), to deal
69+
in the Software without restriction, including without limitation the rights
70+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
71+
copies of the Software, and to permit persons to whom the Software is
72+
furnished to do so, subject to the following conditions:
73+
74+
The above copyright notice and this permission notice shall be included in all
75+
copies or substantial portions of the Software.
76+
77+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
78+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
79+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
80+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
81+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
82+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
83+
SOFTWARE.

‎plugins/obsidian/README.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Obsidian for ZCode
2+
3+
[中文文档](./README_CN.md)
4+
5+
This ZCode plugin packages the six agent skills from [kepano/obsidian-skills](https://github.com/kepano/obsidian-skills) plus visualization skills from [axtonliu/axton-obsidian-visual-skills](https://github.com/axtonliu/axton-obsidian-visual-skills) — Mermaid and Excalidraw diagram generation, and text-to-canvas layout algorithms folded into `json-canvas` — together with a local `setup` skill, so they can be installed through the ZCode plugin marketplace. The skills teach the agent Obsidian's file formats and companion CLIs — no MCP servers or hooks are bundled.
6+
7+
## Prerequisites
8+
9+
Skills in this plugin rely on external CLIs and verify them at runtime:
10+
11+
- [Obsidian CLI](https://help.obsidian.md/cli) (`obsidian`) — required by the `obsidian-cli` skill, and a running Obsidian instance
12+
- [Defuddle](https://github.com/kepano/defuddle) (`npm install -g defuddle`) — required by the `defuddle` skill
13+
- [Knap](https://github.com/obsidianmd/knap) (`npm install -g knap`, Node.js 20+) — required by the `knap` skill
14+
15+
- [Excalidraw plugin](https://github.com/zsviczian/obsidian-excalidraw-plugin) (community plugin, install from inside Obsidian) — required by the `excalidraw-diagram` skill for its Obsidian `.md` output mode; the standard `.excalidraw` output opens on excalidraw.com without it
16+
17+
The other skills (`obsidian-markdown`, `obsidian-bases`, `json-canvas`, `mermaid-visualizer`) only read and write files in your vault and have no dependencies.
18+
19+
Run `/obsidian:setup` to verify these tools on a new machine and get guided installation (`/obsidian:setup obsidian` checks a single component).
20+
21+
Before installation or environment changes — during setup, or when the `defuddle` and `knap` skills find a tool missing — the plugin shows the proposed actions and asks for confirmation via Ask User (or in the conversation if the tool is unavailable). You can choose manual installation or skip; read-only checks do not require confirmation.
22+
23+
## Skills
24+
25+
| Skill | Description |
26+
|-------|-------------|
27+
| setup | Verify and install the plugin's CLI dependencies: official Obsidian CLI registration, defuddle, and knap |
28+
| obsidian-markdown | Create and edit Obsidian Flavored Markdown with wikilinks, embeds, callouts, and properties |
29+
| obsidian-bases | Create and edit `.base` files with views, filters, formulas, and summaries |
30+
| json-canvas | Create and edit `.canvas` whiteboard files with nodes, edges, and groups; generate MindMap or freeform canvases from text content |
31+
| mermaid-visualizer | Turn text into professional Mermaid diagrams (flows, mindmaps, sequence, state) with built-in syntax-error prevention |
32+
| excalidraw-diagram | Generate hand-drawn style Excalidraw diagrams in three modes: Obsidian `.md`, standard `.excalidraw`, and animated |
33+
| obsidian-cli | Read, create, search, and manage notes in a running Obsidian vault; plugin/theme development support |
34+
| defuddle | Extract clean markdown from web pages, stripping navigation and ads to save tokens |
35+
| knap | Render markdown notes from templates and JSON/CSV data, including batch generation |
36+
37+
Skills are invoked automatically when relevant (e.g. editing a `.base` file or saving a web article into your vault). You can also trigger them explicitly, for example `/obsidian:obsidian-markdown` or `/obsidian:knap`.
38+
39+
## Examples
40+
41+
```text
42+
# Turn a web article into a clean note in the vault
43+
Read https://example.com/article and save it as a note in my vault
44+
45+
# Build a literature database over the vault
46+
Create a .base file showing all notes tagged #book, grouped by status, with rating shown as a card view
47+
48+
# Batch-generate notes from structured data
49+
Use knap to render one note per row of books.csv using my book template
50+
51+
# Visualize content as diagrams
52+
Turn this article into an Excalidraw mind map
53+
Create a Mermaid flowchart of the CI/CD pipeline and save it into my vault
54+
```
55+
56+
## Attribution
57+
58+
The six core skills are authored by [Steph Ango](https://github.com/kepano); the `mermaid-visualizer` and `excalidraw-diagram` skills, plus the layout algorithms folded into `json-canvas`, are by [Axton Liu](https://github.com/axtonliu). Both sets are imported from their upstream repositories — see [UPSTREAM.md](./UPSTREAM.md) for the imported commits, licenses, and adaptation deltas. This adaptation adds the ZCode plugin manifests, marketplace registration, this documentation, and a local `setup` skill; all other skills are upstream-derived.

‎plugins/obsidian/README_CN.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# ZCode 的 Obsidian 插件
2+
3+
[English](./README.md)
4+
5+
本插件将 [kepano/obsidian-skills](https://github.com/kepano/obsidian-skills) 的六个 agent 技能与 [axtonliu/axton-obsidian-visual-skills](https://github.com/axtonliu/axton-obsidian-visual-skills) 的可视化技能(Mermaid/Excalidraw 图表生成,以及并入 `json-canvas` 的文本转画布布局算法)打包为 ZCode 插件,并附带一个本地 `setup` 技能,可通过 ZCode 插件市场安装。这些技能教 agent 使用 Obsidian 的文件格式与配套 CLI——插件本身不包含 MCP 服务或 hooks。
6+
7+
## 前置条件
8+
9+
插件中的技能依赖外部 CLI，运行时会自行检查：
10+
11+
- [Obsidian CLI](https://help.obsidian.md/cli)（`obsidian`）——`obsidian-cli` 技能需要，且要求 Obsidian 正在运行
12+
- [Defuddle](https://github.com/kepano/defuddle)（`npm install -g defuddle`）——`defuddle` 技能需要
13+
- [Knap](https://github.com/obsidianmd/knap)（`npm install -g knap`，需 Node.js 20+）——`knap` 技能需要
14+
15+
- [Excalidraw 插件](https://github.com/zsviczian/obsidian-excalidraw-plugin)（社区插件，在 Obsidian 内安装）——`excalidraw-diagram` 技能的 Obsidian `.md` 输出模式需要；标准 `.excalidraw` 输出可直接在 excalidraw.com 打开，无此依赖
16+
17+
其余技能（`obsidian-markdown`、`obsidian-bases`、`json-canvas`、`mermaid-visualizer`）只读写 vault 中的文件，无任何依赖。
18+
19+
在新机器上运行 `/obsidian:setup` 可检测这些工具并引导安装（`/obsidian:setup obsidian` 只检查单个组件）。
20+
21+
安装或修改环境前——无论是 setup 流程，还是 `defuddle`、`knap` 技能发现工具缺失时——插件都会展示具体操作，并通过 Ask User 请求确认（工具不可用时在对话中询问并等待答复）。你可以选择手动安装或跳过；只读检测无需确认。
22+
23+
## 技能列表
24+
25+
| 技能 | 说明 |
26+
|------|------|
27+
| setup | 检测并安装插件的 CLI 依赖：Obsidian CLI 官方注册流程、defuddle、knap |
28+
| obsidian-markdown | 创建和编辑 Obsidian 风格 Markdown：双链、嵌入、callout、属性 |
29+
| obsidian-bases | 创建和编辑 `.base` 文件：视图、筛选、公式、汇总 |
30+
| json-canvas | 创建和编辑 `.canvas` 白板文件：节点、连线、分组；支持从文本内容生成 MindMap/自由布局画布 |
31+
| mermaid-visualizer | 把文本转为专业 Mermaid 图（流程、思维导图、时序、状态），内置语法防错规则 |
32+
| excalidraw-diagram | 生成手绘风格 Excalidraw 图，三种模式：Obsidian `.md`、标准 `.excalidraw`、动画 |
33+
| obsidian-cli | 读写、搜索、管理运行中 Obsidian 库的笔记；支持插件/主题开发调试 |
34+
| defuddle | 从网页提取干净正文为 Markdown，去掉导航广告等杂质以节省 token |
35+
| knap | 用模板和 JSON/CSV 数据渲染 Markdown 笔记，支持批量生成 |
36+
37+
技能会在相关场景自动触发（例如编辑 `.base` 文件、把网页文章存入 vault），也可以显式调用，例如 `/obsidian:obsidian-markdown`、`/obsidian:knap`。
38+
39+
## 使用示例
40+
41+
```text
42+
# 把一篇网页文章提取成干净笔记存入 vault
43+
读取 https://example.com/article 并保存为我 vault 里的笔记
44+
45+
# 给 vault 建一个文献数据库
46+
创建一个 .base 文件，展示所有带 #book 标签的笔记，按 status 分组，用卡片视图显示评分
47+
48+
# 用结构化数据批量生成笔记
49+
用 knap 按 books.csv 的每一行数据、套用我的图书模板批量生成笔记
50+
51+
# 把内容可视化成图
52+
把这篇文章整理成 Excalidraw 思维导图
53+
画一个 CI/CD 流水线的 Mermaid 流程图，存到我的 vault 里
54+
```
55+
56+
## 署名
57+
58+
六个核心技能作者为 [Steph Ango](https://github.com/kepano)；`mermaid-visualizer`、`excalidraw-diagram` 两个技能以及并入 `json-canvas` 的布局算法来自 [Axton Liu](https://github.com/axtonliu)。两组技能均从各自上游仓库导入——导入的 commit、许可证与适配差异见 [UPSTREAM.md](./UPSTREAM.md)。本次适配增加了 ZCode 插件清单、市场注册、本文档与一个本地 `setup` 技能；其余技能内容均来自上游。

0 commit comments

Comments
 (0)