diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml new file mode 100644 index 0000000..964db73 --- /dev/null +++ b/.github/workflows/pages.yml @@ -0,0 +1,48 @@ +name: Deploy manual to GitHub Pages + +# 只发布 docs/manual/ 这一个目录作为 Pages 站点根。 +# 其余 docs/（内部设计文档、任务笔记等）完全不参与发布，也不触发 Jekyll。 +on: + push: + branches: [main] + paths: + - "docs/manual/**" + - ".github/workflows/pages.yml" + workflow_dispatch: + +permissions: + contents: read + pages: write + id-token: write + +# 同一时刻只跑一个部署；不打断进行中的部署。 +concurrency: + group: pages + cancel-in-progress: false + +jobs: + deploy: + runs-on: ubuntu-latest + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Configure Pages + # enablement: true —— 首次运行时自动把 Pages 源切到 "GitHub Actions"， + # 无需手动去 Settings 开。若组织策略禁止自动开启，改为手动在 + # Settings → Pages → Source 选 "GitHub Actions" 后重跑本 workflow。 + uses: actions/configure-pages@v5 + with: + enablement: true + + - name: Upload artifact (docs/manual only) + uses: actions/upload-pages-artifact@v3 + with: + path: docs/manual + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/docs/manual/index.html b/docs/manual/index.html new file mode 100644 index 0000000..e2405a5 --- /dev/null +++ b/docs/manual/index.html @@ -0,0 +1,1382 @@ + + + + +MyKnowledge 使用手册 + + + + + + + +
+ +
+
+
+ 苹果内部工具 · enchanté 集成 +

把你的经验交给 AI 打理，随手记，随手找。

+

MyKnowledge 作为 MCP 装在 enchanté 里，由 AI 自动帮你管理一个专属知识库——随口记录、随时恢复、打开 App 就能查看和修改，还能安全分享给同事。

+
+ 开始安装 + 看看能用来做什么 +
+ +
+
+
+ + + + 你在 enchanté 里说一句话 +
+
+
+ + + + MyKnowledge 自动管理你的知识库 +
+
+
+
+ +
+ + 记录 +
+
+
+ +
+ + 恢复 +
+
+
+ +
+ + 可视化 +
+
+
+ +
+ + 修改 +
+
+
+ +
+ + 共享 +
+
+
+
+
+
+
+ + +
+ +
+
+
+
+

Step by step

+

安装，两步搞定

+

先装 App，再跟着引导走一遍——全程不用碰任何配置文件。

+
+ +
+
+
1
+
+
下载并安装
+
+
+ 把 MyKnowledge 拖进 Applications 完成安装 +
1.1

先安装：从内部下载入口拿到 MyKnowledge.dmg，把图标拖进 Applications。

+
+ + 用聚焦搜索打开终端 + +
1.2

打开「终端」：按 ⌘ + 空格 打开搜索，输入 terminal（或"终端"）回车。也可以在「启动台 → 其他 → 终端」里找到它。

+
+ + 在终端里粘贴命令后回车 + +
1.3

粘贴命令并回车：点下面的「复制命令」，回到终端按 ⌘ + V 粘贴，回车执行。跑完没有任何提示就是成功了，关掉终端去打开 App 即可。

+
+
xattr -r -d com.apple.quarantine /Applications/MyKnowledge.app
+ +
+ +

这一步只做一次：App 不是从 App Store 安装的，macOS 会给它加一个"隔离"标记，直接打开会提示"无法验证开发者"，这行命令就是把标记去掉。

+
+
+
+ +
+
2
+
+
打开 App，跟着初始化引导走一遍
+

第一次打开 App 会直接进入初始化引导，四步走完，MyKnowledge 就和你在用的 AI 客户端接上了。想改配置是走完之后的事，见本步末尾。

+
+
+ + 引导第一步：填写身份信息 + +
+ 2.1 +

填身份信息。昵称、邮箱按实际填；企业名称和组织代码是知识库分享用的，保持默认就行。

+
+
+ + 引导第二步：选择 AI 客户端 + +
+ 2.2 +

勾选你在用的 AI 客户端。没装的会标「未安装」并置灰，至少选一个。点下一步，MCP / Hooks / Agent 会自动配好。

+
+
+ + 结论页：为 Enchanté 生成 MCP 链接 + +
+ 2.3 +

Enchanté 要多点一下：在结论页点「生成 MCP 链接」。

+
+
+ + 在 Enchanté 里点 Install MCP 完成注入 + +
+ 2.4 +

浏览器跳到 Enchanté，配置已经自动填好，点右上角「Install MCP」就接上了。

+
+
需要 Agent 的话，按下面新建一个 MyKnowledge Agent
+
+ + + +
+ 2.5 +

打开 Enchanté 设置 → Agents，点右上角「New Agent」新建。

+
+
+ + + +
+ 2.6 +

Name 填「MyKnowledge 知识管理专家」，点下一步。（Type 默认 Local，不用管）

+
+
+ + + +
+ 2.7 +

把系统提示词一键复制，粘进「System Prompt」，点下一步。

+
+ + + +
+ 2.8 +

在 MCP Servers 里勾选「MyKnowledge」，下一步；之后 Collaboration 直接跳过、Review 点创建。

+
+
+ + + +
+ 2.9 +

回到对话页，点左下角 Agent 选择器，选「MyKnowledge 知识管理专家」就启用了。

+
+
走完之后想改配置，从这两个地方进
+
+ + 点右上角头像打开设置 + +
+ 改配置 ① +

点右上角头像 → 设置。

+
+
+ + 设置 → 通用 → 重新运行初始化引导 + +
+ 改配置 ② +

「通用」页可以「重新运行初始化引导」整个重来；左边 MCP / Hooks / Agents 三页则是单项开关。

+
+
+
+ + 引导里不用纠结选项。配好之后随时能改：打开设置 → MCP / Hooks / Agents，每个平台一行开关，也能点「重新检测」看当前状态。 +
+
+
+
+
+
+ +
+
+
+

Everyday scenarios

+

日常怎么用 Enchanté

+
+ + +
📌 开始前先选中 Agent：日常使用前，请确认已经建好并选中我们的 Agent——在 Enchanté 对话页左下角的 Agent 选择器里，选中 MyKnowledge 知识管理专家 再开始下面的操作。（还没建的话见上面 2.5–2.9）
+
+
+
+
+ + 在 enchanté 里让 AI 建项目并记录内容 + + + + +
+
+
+ 场景一 · 记录 +

随口一说，AI 帮你记下来

+

跟 AI 说一声"帮我记一下"，它就写成笔记并自动归档。需要你主动开口，AI 不会自己监听。

+
    +
  • 1主动在 enchanté 里告诉 AI 你想记录的内容
    • +
  • 2AI 通过 MyKnowledge 写入知识库合适的位置
    • +
  • 3改动自动提交版本，随时可以查看历史
    • +
+
+
+ +
+
+
+
+ + 让 AI 复述历史口径并做环比分析 + + + +
+
+
+ 场景二 · 回顾与续写 +

让 AI 先读懂过去，再帮你往下走

+

告诉 AI"参考一下 XX 项目"，它会先读知识库里的历史记录，再帮你总结进度或写初稿——有据可查，不是凭空编。

+
    +
  • 1告诉 AI 想回顾的项目，或想参考的内容
    • +
  • 2AI 读取知识库里相关的历史笔记
    • +
  • 3得到进度总结，或一份可以直接改的初稿
    • +
+
+
+ +
+
+
+
+
+
+ + MyKnowledge 网页版仪表盘 + + + +
+
    +
  • 1左栏：所有项目和它们下面的笔记
    • +
  • 2仪表盘：项目数与文档数总览
    • +
+
+
+
+
+ + MyKnowledge 网页版项目详情 + + + + + + +
+
    +
  • 1项目详情 = 标题 + 摘要
    • +
  • 2知识：你和 AI 沉淀进来的笔记内容
    • +
  • 3每篇笔记都能单独删除
    • +
  • 4项目下面还能再建子项目
    • +
  • 5项目做完之后就进入归档
    • +
+
+
+
+
+ 场景三 · 前端查看 +

不想打字问 AI？打开 App 翻一翻

+

只想翻看笔记时，不用跟 AI 对话。打开 MyKnowledge App，像浏览文件一样点开每个项目、每篇笔记。

+
    +
  • 1打开 MyKnowledge App
    • +
  • 2仪表盘能看到所有项目和文档的总览
    • +
  • 3点开任意一个项目，浏览里面的每篇笔记
    • +
+
+ + 你跟 AI 对话沉淀的知识、建立的项目，都会同时出现在这里：文件存在你自己的电脑上，也能在这个 App 里看到。 +
+
+
+ +
+
+
+
+ + 在 MyKnowledge App 里直接编辑一篇笔记 + + + + +
+
+
+ 场景四 · 修改 +

看着不对？在 App 里直接改

+

不用回去找 AI 重写。任何一篇笔记都能在 MyKnowledge App 里打开就改——补一段、删一句、调排版，改完就是最新版本，AI 下次读到的也是它。

+
    +
  • 1点开任意一篇笔记，正文直接可编辑
    • +
  • 2选中文字浮出工具条：加粗、斜体、下划线、代码、链接
    • +
  • 3改完自动保存并提交版本，改错了也能回退
    • +
+
+ + 你在 App 里的修改和 AI 的写入走的是同一份文件：谁改都算数，改动都留在版本历史里。 +
+
+
+ +
+
+
+
+
+ + 把项目导出为加密分享包 + + + +
+
    +
  • 1你这边：勾选项目，导出成加密的 .mkpkg
    • +
+
+
+
+ + 把 .mkpkg 丢给 AI，一句话导入知识库 + +
+
    +
  • 2同事那边：把文件丢给 AI，说一句「导入知识库」就好
    • +
+
+
+
+
+ 场景五 · 分享 +

把一部分知识，安全地分享给同事

+

不用公开整个知识库。把选定的项目打包成加密的 .mkpkg 发给同事；对方不用学任何操作，把文件丢给自己的 AI，一句话就装进他的知识库。

+
    +
  • 1告诉 AI 要分享哪部分内容，它打包成加密的 .mkpkg
    • +
  • 2通过邮件 / IM 发出去，只有拿到包的人能看
    • +
  • 3对方把文件丢给装了 MyKnowledge 的 AI（enchanté 里可以自己挑 Agent），说一句「导入知识库」，剩下的它自己搞定
    • +
+
+
+
+
+ +
+
+
+

Good to know

+

常见问题

+

用之前大家最常问的几个问题。

+
+ +
+
+ 我的笔记会不会被上传到公网，或者苹果以外的服务器？ + + +

不会。MyKnowledge 是「本地优先」的工具，所有笔记都以 Markdown 文件的形式，保存在你自己电脑的 ~/.myknowledge/ 目录里。它本身不内置任何大模型，也不会主动联网上传数据；云同步是一个可选功能，只有你自己主动配置了才会启用。

+
+
+ AI 会不会手滑改错、删错我的笔记？ + + +

每一次写入都会自动生成一条 Git 版本记录，相当于随时都有「历史存档」，改错了也能找回改动前的版本。同时系统会给每次写入自动加锁，避免多个操作同时冲突导致内容损坏。

+
+
+ 用了一段时间后，版本落后了怎么办？ + + +

App 会自动检测新版本，有更新时会提示你，点一下就能完成更新，不需要自己动手操作。

+
+
+ 引导里配错了，或者以后想关掉，怎么办？ + + +

打开设置，左边有 MCP / Hooks / Agents 三页，每个平台一行开关，随时开、随时关；点「重新检测」还能确认当前到底连没连上。想整个重来，就到「通用」页点「重新运行初始化引导」。

+
+
+ 安装或连接过程中卡住了，找谁帮忙？ + + +

把卡住那一步的界面截个图，发邮件给团队内负责 enchanté / MyKnowledge 的同事：（此处填邮箱）。大部分问题是 Git 没装好，或者 enchanté 里粘贴的配置不完整。

+
+
+
+
+ +
+
+ + + + +