mcpField
W
wiki-sync

wiki-sync

github.com/richard-kim-79生产力50227 次安装23 周前更新
代码仓库

关于 wiki-sync

wiki-sync 是一项将研究笔记整理为结构化知识库的技能,适合需要把零散笔记转为可交叉链接 wiki 的用户。它规定单页单概念、来源标注和自动维护索引,并支持配置页面数量、输出目录与语言。

主要功能

  1. 01从现有笔记提取概念
  2. 02按概念创建或更新页面
  3. 03生成并维护 wiki 索引
  4. 04添加页面间双向引用
  5. 05配置输出目录与语言

适用场景

  1. 01把零散研究笔记整理成 wiki
  2. 02持续更新已有概念页面
  3. 03为页面建立来源和关联链接

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/richard-kim-79/archora-skills --skill wiki-sync

安装后在 Claude Code 中输入/wiki-sync确认已加载。

详细介绍

Wiki 同步

将研究笔记整理为结构化的 Wiki 知识库。

Wiki 约定

  • Slug:小写 kebab-case(protein-folding、hypothesis-1)
  • Wiki 链接:使用 [[slug]] 创建内部链接,使用 [[slug|Display Text]] 设置自定义标签
  • 索引:始终维护一个 index.md,其中包含所有页面的表格
  • 每页一个概念:每个页面应聚焦于单个实体、概念或主题
  • 来源部分:每个页面末尾都应有一个 ## Sources 部分,列出信息来源

工作流

  1. 审核现有笔记 — 列出所有文件,识别已有 Wiki 结构的内容
  2. 识别概念 — 从非结构化笔记中提取关键实体、主题和关系
  3. 创建/更新页面 — 每个概念创建一个页面,并添加交叉链接
  4. 构建索引 — 生成或更新 index.md
  5. 报告 — 列出新建页面、已更新页面和新增链接

页面模板

# [Page Title]

[1–2 sentence summary of this concept]

## Overview
[Detailed content about this concept]

## Related Concepts
- [[related-slug-1]] — [brief description of relationship]
- [[related-slug-2]] — [brief description of relationship]

## Sources
- [Source name/file]
- [Source URL if applicable]

*Last updated: [date]*

索引模板

# Wiki Index

> Auto-maintained index of all wiki pages.

| Page | Summary | Updated |
|------|---------|---------|
| [[slug-1]] Page Title | One-line summary | YYYY-MM-DD |
| [[slug-2]] Page Title | One-line summary | YYYY-MM-DD |

配置

在笔记目录中添加 wiki-sync.config.md 文件即可覆盖默认设置:

# Wiki Sync Config

maxPages: 20
outputDir: wiki/
indexFile: index.md
language: en
选项默认值说明
maxPages8每次同步最多创建的页面数。笔记集合较大时可增加此值。
outputDir.(与笔记位于同一目录)写入 Wiki 页面的子目录
indexFileindex.md自动生成的索引文件名
languageen生成文本所用的语言(en、ko、ja 等)

如果没有配置文件,则使用所有默认设置。

规则

  • 每次同步默认最多创建 8 个页面 — 可在配置中通过 maxPages 覆盖(避免让用户应接不暇)
  • 增量同步时,优先更新现有页面,而不是创建新页面
  • 绝不删除现有内容 — 追加内容或更新部分章节
  • 添加页面后,始终重新构建索引
  • 如果配置中设置了 outputDir,请遵循该设置 — 将所有新页面写入该目录

评论

支持 Markdown