Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added .github/assets/website.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
83 changes: 56 additions & 27 deletions README.en.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,29 @@
[中文](./README.md) | [English](./README.en.md) | [🤖 Agent Install](./AGENT-INSTALL.md)
<div align="center">

# Yuque AI Ecosystem
<a href="https://yuque.github.io/yuque-ecosystem/"><img src="https://avatars.githubusercontent.com/u/34602419?s=200&v=4" width="88" alt="Yuque logo"></a>

> The official distribution repository for Yuque AI integrations — one set of skills, ready to use in any AI client, plus the website that presents them.
<h1>Yuque AI Ecosystem</h1>

[![Website](https://img.shields.io/badge/Website-yuque.github.io-blue)](https://yuque.github.io/yuque-ecosystem/)
[![npm](https://img.shields.io/npm/v/yuque-mcp)](https://www.npmjs.com/package/yuque-mcp)
The official distribution repository for Yuque AI integrations —<br>one set of knowledge-management skills, ready to use in any AI client.

📖 **[Yuque + AI: From Documentation Tool to Your Second Brain](https://www.yuque.com/yuque/ai/yuque-ai-ecosystem-final)** — Explore the full vision of the Yuque AI Ecosystem
[![Website][website-image]][website-url] [![Deploy][deploy-image]][deploy-url] [![npm][npm-image]][npm-url]

## Positioning
[🌐 Website](https://yuque.github.io/yuque-ecosystem/) · [🚀 Quick Start](#quick-start) · [🤖 Agent Install](./AGENT-INSTALL.md) · [📖 Full Vision](https://www.yuque.com/yuque/ai/yuque-ai-ecosystem-final) · [中文](./README.md)

**Skills are the asset, client integrations are distribution, the website is the storefront.** Capability and experience live in separate repositories: [yuque-mcp-server](https://github.com/yuque/yuque-mcp-server) defines what the AI *can do* (MCP tools); this repository defines how users *get it* (skill workflows, install docs, and the website).
<a href="https://yuque.github.io/yuque-ecosystem/"><img src=".github/assets/website.png" alt="Yuque AI Ecosystem website"></a>

| Layer | Content | Location |
|---|---|---|
| Capability | MCP Server (npm: `yuque-mcp`) | [yuque-mcp-server](https://github.com/yuque/yuque-mcp-server) |
| Asset | Knowledge-management skills (single source, standard SKILL.md format) | [`skills/`](./skills/) |
| Distribution | AGENT-INSTALL.md all-client install guide (copy skills/ to install) | [`AGENT-INSTALL.md`](./AGENT-INSTALL.md) |
| Storefront | Website (showcase + install guides) | [`website/`](./website/) |
</div>

SKILL.md is a cross-client format — OpenCode, OpenClaw, and any other skills-capable client can copy [`skills/`](./skills/) into their own skills directory directly; no dedicated adapter layer needed. Every client uses the same two steps: configure MCP and copy `skills/`.
## Skills (8)

## Repository Structure

```
yuque-ecosystem/
├── skills/ # ★ The asset: 8 knowledge-management skills (single source)
├── AGENT-INSTALL.md # All-client install guide (directly executable by agents)
├── website/ # Official website (GitHub Pages)
├── scripts/ # Validation scripts
└── .github/ # CI, preview, and deployment workflows
```
- 📥 **daily-capture** — Capture fleeting ideas and periodically organize them into structured knowledge
- 🔍 **smart-search** — Search your Yuque knowledge bases with natural language and synthesize answers
- 📝 **smart-summary** — Summarize a doc or book at one-line, key-point, or detailed level
- 📚 **reading-digest** — Extract core insights, golden quotes, and action items into reading notes
- ✨ **note-refine** — Polish rough notes into structured documents while preserving your voice
- 🔗 **knowledge-connect** — Uncover related topics and complementary notes, build cross-links
- 🧹 **stale-detector** — Scan a knowledge base for outdated documents and recommend updates
- 🎨 **style-extract** — Distill your vocabulary, sentence, and tone patterns into a personal style guide

> **The team edition (yuque-group) is temporarily withdrawn**: its skills depend on group-statistics MCP tools (`yuque_group_*`) that are not yet available in `yuque-mcp`. It will return once the underlying tools ship. See git history for the previous code.

Expand All @@ -55,19 +47,56 @@ Two generic steps: ① configure `yuque-mcp`; ② if the client supports skills,

Per-client commands live in [`AGENT-INSTALL.md`](./AGENT-INSTALL.md) — hand that file to your AI agent and it will install everything.

## Positioning

**Skills are the asset, client integrations are distribution, the website is the storefront.** Capability and experience live in separate repositories: [yuque-mcp-server](https://github.com/yuque/yuque-mcp-server) defines what the AI *can do* (MCP tools); this repository defines how users *get it* (skill workflows, install docs, and the website).

| Layer | Content | Location |
| ------------ | ------------------------------------------------------------- | ------------------------------------------------------------- |
| Capability | MCP Server (npm: `yuque-mcp`) | [yuque-mcp-server](https://github.com/yuque/yuque-mcp-server) |
| Asset | Knowledge-management skills (single source, SKILL.md format) | [`skills/`](./skills/) |
| Distribution | All-client install guide (copy skills/ to install) | [`AGENT-INSTALL.md`](./AGENT-INSTALL.md) |
| Storefront | Website (showcase + install guides) | [`website/`](./website/) |

SKILL.md is a cross-client format — OpenCode, OpenClaw, and any other skills-capable client can copy [`skills/`](./skills/) into their own skills directory directly; no dedicated adapter layer needed. Every client uses the same two steps: configure MCP and copy `skills/`.

<details>
<summary>Repository structure</summary>

```
yuque-ecosystem/
├── skills/ # ★ The asset: 8 knowledge-management skills (single source)
├── AGENT-INSTALL.md # All-client install guide (directly executable by agents)
├── website/ # Official website (GitHub Pages)
├── scripts/ # Validation scripts (skills frontmatter & MCP tool references)
└── .github/ # CI, preview, and deployment workflows
```

</details>

## Development

```bash
# Website development
cd website && npm install && npm run dev

# Validate skills
node scripts/validate-skills.mjs
```

## Links

- [npm: yuque-mcp](https://www.npmjs.com/package/yuque-mcp)
- [Website](https://yuque.github.io/yuque-ecosystem/)
- [yuque-mcp-server](https://github.com/yuque/yuque-mcp-server)
- [yuque-mcp-server](https://github.com/yuque/yuque-mcp-server) — the capability layer: MCP server source
- [Yuque + AI: From Documentation Tool to Your Second Brain](https://www.yuque.com/yuque/ai/yuque-ai-ecosystem-final)

## License

MIT © [Yuque](https://www.yuque.com)

[website-image]: https://img.shields.io/badge/website-yuque.github.io-00B96B?style=flat-square
[website-url]: https://yuque.github.io/yuque-ecosystem/
[deploy-image]: https://img.shields.io/github/actions/workflow/status/yuque/yuque-ecosystem/deploy-website.yml?style=flat-square&label=deploy
[deploy-url]: https://github.com/yuque/yuque-ecosystem/actions/workflows/deploy-website.yml
[npm-image]: https://img.shields.io/npm/v/yuque-mcp?style=flat-square&label=yuque-mcp
[npm-url]: https://www.npmjs.com/package/yuque-mcp
91 changes: 60 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,33 @@
[中文](./README.md) | [English](./README.en.md) | [🤖 Agent Install](./AGENT-INSTALL.md)
<div align="center">

# Yuque AI Ecosystem — 语雀 AI 生态
<a href="https://yuque.github.io/yuque-ecosystem/"><img src="https://avatars.githubusercontent.com/u/34602419?s=200&v=4" width="88" alt="语雀 logo"></a>

> 语雀 AI 集成的官方分发仓库 — 一套 Skills,任意客户端开箱即用,外加承载它们的官网。
<h1>Yuque AI Ecosystem</h1>

[![Website](https://img.shields.io/badge/Website-yuque.github.io-blue)](https://yuque.github.io/yuque-ecosystem/)
[![npm](https://img.shields.io/npm/v/yuque-mcp)](https://www.npmjs.com/package/yuque-mcp)
语雀 AI 生态官方分发仓库<br>一套知识管理 Skills,任意 AI 客户端开箱即用。

📖 **[语雀 + AI:从文档工具到你的第二大脑](https://www.yuque.com/yuque/ai/yuque-ai-ecosystem-final)** — 了解语雀 AI 生态的完整愿景
[![Website][website-image]][website-url] [![Deploy][deploy-image]][deploy-url] [![npm][npm-image]][npm-url]

## 定位
[🌐 官网](https://yuque.github.io/yuque-ecosystem/) · [🚀 快速开始](#快速开始) · [🤖 Agent 安装](./AGENT-INSTALL.md) · [📖 完整愿景](https://www.yuque.com/yuque/ai/yuque-ai-ecosystem-final) · [English](./README.en.md)

**Skills 是资产,客户端接入是分发,官网是门面。** 能力与体验分属两个仓库:[yuque-mcp-server](https://github.com/yuque/yuque-mcp-server) 定义 AI *能做什么*(MCP 工具),本仓库定义用户*怎么用上*(Skills 编排、安装文档与官网)。
<a href="https://yuque.github.io/yuque-ecosystem/"><img src=".github/assets/website.png" alt="Yuque AI Ecosystem 官网首页"></a>

| 层 | 内容 | 位置 |
|---|---|---|
| 能力层 | MCP Server(npm: `yuque-mcp`) | [yuque-mcp-server](https://github.com/yuque/yuque-mcp-server) |
| 资产层 | 知识管理 Skills(唯一源,标准 SKILL.md 格式) | [`skills/`](./skills/) |
| 分发层 | AGENT-INSTALL.md 全客户端安装指南(复制 skills/ 即安装) | [`AGENT-INSTALL.md`](./AGENT-INSTALL.md) |
| 门面层 | 官网(展示 + 安装引导) | [`website/`](./website/) |
</div>

SKILL.md 是跨客户端的通用格式——OpenCode、OpenClaw 等客户端直接把 [`skills/`](./skills/) 拷进各自的 skills 目录即可,无需专门的适配层。所有客户端统一走「配 MCP + 复制 skills/」两步。
## Skills(8 个)

## Repository Structure

```
yuque-ecosystem/
├── skills/ # ★ 资产:8 个知识管理 Skills(唯一源)
├── AGENT-INSTALL.md # 全客户端安装指南(agent 可直接执行)
├── website/ # 官网(GitHub Pages)
├── scripts/ # 校验脚本
└── .github/ # CI、预览与部署工作流
```
- 📥 **daily-capture** — 随手速记灵感,定期整理成结构化知识
- 🔍 **smart-search** — 用自然语言搜索你的语雀知识库并综合作答
- 📝 **smart-summary** — 按一句话 / 要点 / 详细三档总结文档或知识库
- 📚 **reading-digest** — 从文章提炼核心洞见、金句与行动项,生成阅读笔记
- ✨ **note-refine** — 把粗糙小记打磨成结构清晰的文档,保留你的原声
- 🔗 **knowledge-connect** — 发现文档间的关联话题与互补笔记,建立交叉链接
- 🧹 **stale-detector** — 扫描知识库中的过时文档并给出更新建议
- 🎨 **style-extract** — 提炼你的用词、句式与语气,形成个人文风指南

> **团队版(yuque-group)已暂时下线**:其 skills 依赖的团队统计类 MCP 工具(`yuque_group_*`)尚未在 `yuque-mcp` 中提供,待底层工具就绪后再重新上架。历史代码见 git 记录。

## Quick Start
## 快速开始

### Claude Code

Expand All @@ -55,19 +47,56 @@ cp -r "$REPO_DIR/skills/"* ~/.claude/skills/

各客户端的具体命令见 [`AGENT-INSTALL.md`](./AGENT-INSTALL.md) —— 把这个文件直接丢给你的 AI agent,它就会装。

## Development
## 定位

**Skills 是资产,客户端接入是分发,官网是门面。** 能力与体验分属两个仓库:[yuque-mcp-server](https://github.com/yuque/yuque-mcp-server) 定义 AI *能做什么*(MCP 工具),本仓库定义用户*怎么用上*(Skills 编排、安装文档与官网)。

| 层 | 内容 | 位置 |
| ------ | ----------------------------------------------- | ----------------------------------------------------------- |
| 能力层 | MCP Server(npm: `yuque-mcp`) | [yuque-mcp-server](https://github.com/yuque/yuque-mcp-server) |
| 资产层 | 知识管理 Skills(唯一源,标准 SKILL.md 格式) | [`skills/`](./skills/) |
| 分发层 | 全客户端安装指南(复制 skills/ 即安装) | [`AGENT-INSTALL.md`](./AGENT-INSTALL.md) |
| 门面层 | 官网(展示 + 安装引导) | [`website/`](./website/) |

SKILL.md 是跨客户端的通用格式——OpenCode、OpenClaw 等客户端直接把 [`skills/`](./skills/) 拷进各自的 skills 目录即可,无需专门的适配层。所有客户端统一走「配 MCP + 复制 skills/」两步。

<details>
<summary>仓库结构</summary>

```
yuque-ecosystem/
├── skills/ # ★ 资产:8 个知识管理 Skills(唯一源)
├── AGENT-INSTALL.md # 全客户端安装指南(agent 可直接执行)
├── website/ # 官网(GitHub Pages)
├── scripts/ # 校验脚本(skills frontmatter 与 MCP 工具引用)
└── .github/ # CI、预览与部署工作流
```

</details>

## 开发

```bash
# 官网开发
cd website && npm install && npm run dev

# 校验 skills
node scripts/validate-skills.mjs
```

## Links
## 链接

- [npm: yuque-mcp](https://www.npmjs.com/package/yuque-mcp)
- [Website](https://yuque.github.io/yuque-ecosystem/)
- [yuque-mcp-server](https://github.com/yuque/yuque-mcp-server)
- [yuque-mcp-server](https://github.com/yuque/yuque-mcp-server) — 能力层:MCP Server 源码
- [语雀 + AI:从文档工具到你的第二大脑](https://www.yuque.com/yuque/ai/yuque-ai-ecosystem-final)

## License
## 许可证

MIT © [Yuque](https://www.yuque.com)

[website-image]: https://img.shields.io/badge/website-yuque.github.io-00B96B?style=flat-square
[website-url]: https://yuque.github.io/yuque-ecosystem/
[deploy-image]: https://img.shields.io/github/actions/workflow/status/yuque/yuque-ecosystem/deploy-website.yml?style=flat-square&label=deploy
[deploy-url]: https://github.com/yuque/yuque-ecosystem/actions/workflows/deploy-website.yml
[npm-image]: https://img.shields.io/npm/v/yuque-mcp?style=flat-square&label=yuque-mcp
[npm-url]: https://www.npmjs.com/package/yuque-mcp
Loading