Personalised Local Wiki

基于 Wikmd 的本地 Markdown 维基,支持自动生成与维护知识库。

已扫描
适合谁
知识管理者、长期学习者
不适合谁
无需本地存储的用户、不熟悉命令行操作的用户
国内可用性
基本可用。基本可用,具体体验取决于依赖服务。
安装难度
中等(★★☆)。基于终端操作、依赖、API Key 和本地环境要求的初步判断。

安装与下载

openclaw skills install @errant/personal-memory-wiki

Skill 说明

命令、参数、文件名以原文为准

个人维基

使用 [Wikmd](https://github.com/Linbreux/wikmd) 管理个人维基,这是一款基于文件的维基系统,通过干净的网页界面渲染 Markdown 文件。

使用场景

主动触发 —— 立即使用的情况:

  • “创建关于……的页面”
  • “添加到我的维基”
  • “研究 X 并创建相关页面”
  • “用……更新我的维基”

被动触发 —— 应用维基时参考的情况:

  • 用户提及项目、工作或正在进行的任务
  • 用户讨论研究、学习或探索新主题
  • 用户提到决策、计划或目标
  • 用户反复提及人物、地点或组织
  • 用户询问可能已有文档记录的主题
  • 在提供建议前 —— 检查维基中是否有相关内容
  • 在整合信息时 —— 查看维基中是否存在关联页面

维护触发 —— 更新维基的情况:

  • 完成研究或获取新信息后
  • 学习到值得记住的内容时
  • 做出值得记录的决策后
  • 遇到有用的资源、工具或参考资料时
  • 从对话中发现模式或洞察时
  • 在心跳检查期间 —— 审查过时或不完整的页面

安装

前置条件

  1. Python 3pip 已安装
  2. Git 用于版本控制

安装 Wikmd

pip install wikmd

或推荐使用 pipx 安装:

pipx install wikmd

设置维基目录

  1. 创建你的维基根目录:
mkdir -p ~/personal-wiki/wiki
cd ~/personal-wiki
git init
  1. 在维基根目录下创建基础配置文件(wiki_config.yaml):
wiki_directory: "./wiki"
homepage: "homepage"
homepage_title: "我的维基"
host: "127.0.0.1"
port: 5000
authentication: false
hide_folder_content: false

**注意:如果将 host 设置为 0.0.0.0,可以在网络中访问维基 —— 但需谨慎,这可能导致数据暴露**
  1. 启动维基:
wikmd --config wiki_config.yaml

访问 http://localhost:5000 查看你的维基。

配置

环境变量

此技能需要设置 PERSONAL_WIKI_ROOT 环境变量:

export PERSONAL_WIKI_ROOT="<PATH>/personal-wiki"

通过 OpenClaw 配置设置:

openclaw config set skills.entries.personal-wiki.env.PERSONAL_WIKI_ROOT "<PATH>/personal-wiki"

维基目录结构

以下是一个建议的维基目录结构示例:

PERSONAL_WIKI_ROOT/
├── wiki/                    # Markdown 文件存放于此
│   ├── homepage.md         # 主页
│   ├── projects/
│   │   └── my-project.md
│   ├── research/
│   │   └── topic-notes.md
│   ├── people/
│   │   └── contacts.md
│   ├── decisions/
│   │   └── architecture-choices.md
│   └── resources/
│       └── useful-links.md
├── wiki_config.yaml        # Wikmd 配置文件
└── .git/                   # 版本控制目录

使用维基

读取维基内容

在以下情况请务必先查阅维基:

  1. 提供建议前 —— 维基中可能已记录偏好或限制
  2. 回答问题前 —— 用户可能已进行过相关研究
  3. 制定计划前 —— 可能已有相关项目或目标可对齐
  4. 开展研究前 —— 避免重复劳动,确认已有知识

读取维基的方法:

# 列出所有页面
ls -la $PERSONAL_WIKI_ROOT/wiki

# 查看特定页面
cat $PERSONAL_WIKI_ROOT/wiki/homepage.md
cat $PERSONAL_WIKI_ROOT/wiki/projects/active-project.md

# 搜索内容
grep -r "topic" $PERSONAL_WIKI_ROOT/wiki --include="*.md"

创建页面

  1. wiki 子目录中创建 Markdown 文件:

- 使用文件夹进行分类(如 projects/research/decisions/

- 文件名将作为页面 URL(如 projects/my-project.md/projects/my-project

  1. 使用 Markdown 语法编写内容
  1. 提交更改 —— 维基使用 Git 进行版本控制:
cd $PERSONAL_WIKI_ROOT
git add .
git commit -m "添加关于 X 的页面"

更新页面

向现有页面添加新信息时:

  1. 在相关部分追加内容,或新建章节
  2. 对时间敏感的信息添加日期
  3. 使用 WikiLinks 关联其他页面
  4. 提交更改

与记忆系统集成

维基是记忆系统的延伸:

  • 对话结束后:检查是否有必要记录讨论内容
  • 完成研究后:记录关键发现和资料来源
  • 发现规律时:创建或更新连接相关信息的页面
  • 心跳检查时:检查页面是否需要更新或维护

Wikmd Markdown 功能

Wikmd 支持标准 Markdown 语法,并扩展了以下功能:

  • WikiLinks:使用 [[页面标题]][[另一个页面|自定义文本]] 链接到其他页面
  • 目录:插入 [TOC] 自动生成目录
  • 代码块:使用三重反引号支持语法高亮
  • LaTeX 数学公式:内联使用 $...$,块级使用 $$...$$
  • 图片:将图片存放在 wiki/images/ 目录,使用 ![alt](images/pic.jpg) 引用
  • Mermaid 图表:可创建流程图、序列图等

完整语法说明请参见 [Wikmd 文档](https://linbreux.github.io/wikmd/)。

隐私与安全

  • 作用范围:该技能仅在 PERSONAL_WIKI_ROOT/wiki 目录中创建或修改 Markdown 文件,从 https://linbreux.github.io/wikmd/ 读取文档,并在本地 HTTP 服务器上托管维基
  • 数据处理:所有内容均本地存储;不会发送至外部服务
  • 版本控制:使用 git 追踪变更并保留历史记录
E
@errant

已收录 1 个 Skill

相关推荐