配置指南

Notedown 是一个高度可定制的方案,通过配置 Git 云端同步和 AI 助手,你可以将其打造为一个强大的个人知识库系统。

1. Git 云端同步配置

Notedown 将 Git 仓库视为后端存储(Serverless 模式)。下面分别给出 GiteeGiteaGitHub 的推荐配置流程。

第一步:获取访问令牌 (Token)

前往你选择的平台,创建一个 Personal Access Token (PAT)

  • Gitee: 个人设置 -> 私人令牌
  • GitHub: Settings -> Developer settings -> Tokens (classic)
  • 权限要求: 必须具备对目标仓库的 readwrite 权限。

第二步:填写设置

在Notedown插件的左下角“设置”中填写以下字段:

字段名说明
Repo Owner用户名或组织名
Repo Name仓库名称(建议设为私有)
Branch通常为 mainmaster
Namespace命名空间,即你想将你的笔记存在仓库的哪个目录下
Token粘贴你刚生成的私钥

Gitee

1) 进入 Gitee → 个人设置 → 私人令牌,选中 repo 权限;2) 在插件的设置中填写 Repo Owner/Name/Branch(默认 master),Token 即可同步;3) 推荐使用私有仓库。

Gitea(私有化部署)

1) 在 Gitea Web 控制台创建访问凭证,授权至少 write;2) 配置 Git 平台地址为你的内网域名 + API 路径(例如 https://git.mnt.ltd/api/v1)并填写 Token。

GitHub

1) 前往 GitHub Settings → Developer Settings → Tokens (classic),选择 repo 并设置读写权限;2) 将仓库设为私有,记下 Owner/Repo 名称;3) 填写 Notedown 设置,建议使用 main 分支并保持 Token 最新。

2. AI 助手配置 (OpenAI 兼容)

AI 功能可以帮助你在阅读和整理笔记时进行摘要提取、全文翻译或润色。这不是核心功能,但能极大提升效率。

  • 启用 AI: 在设置页面勾选“启用 OpenAI”。
  • Completions URL: 请填写完整的接口地址。例如:
    https://api.openai.com/v1/chat/completions
  • API Key / Model: 输入你的密钥和模型(如 gpt-4o-mini)。

3. 常见报错排查

Sync Error: 404 (Branch not found)

请确认填写的分支名称与 Git 平台上的默认分支完全一致。

Sync Error: 401 (Unauthorized)

Token 填写错误或权限不足。请检查 PAT 是否勾选了 reporepository_write 权限项。