logo
mdocs
首页
特性
开始
文档
GitHub
首页
特性
开始
文档
GitHub
logo
mdocs

快速开始

安装
第一个知识库

AI 与 Agent

智能助手(AI)
Agent 开发闭环
CLI Token

核心概念

所见皆文件
工作空间
文档级邀请
无账户身份识别

使用指南

设置页面概览
Markdown 编辑
HTML 文档
流程图生成
知识图谱
草稿与同步
我的文章与邀请
文档收藏
文档评论
受限工作空间成员与模板
恢复码(兼容)

部署与配置

环境要求
配置文件
反向代理示例
客户端壳(Android / 桌面)
FAQ
更新日志
Next Page安装
mdocs

Write freely. Never lose a word.

MIT License
产品
功能特性Agent 开发闭环竞品对比更新日志
资源
文档安装指南
社区
GitHub问题反馈
© 2026 mdocs · Made with ♥ by xuhuafeifei

#全文搜索

mdocs 内置基于 FTS5(SQLite 全文索引)的关键词搜索,并可选叠加本地语义检索(Embedding)。

#搜索入口

  • 侧栏:目录区域的搜索图标
  • 快捷键:⌘K(macOS)/ Ctrl+K(Windows / Linux)
  • 设置 → 我的文章:列表上方搜索框(可切换检索模式)

打开 ⌘K 浮层后,默认搜全部可见工作空间;可用工作空间下拉限定一域。点击结果打开文章并关闭浮层。

#检索模式

模式行为
自动(默认)先关键词(标题 + 正文),再尽力补语义近邻
仅关键词只用 FTS,不走向量
仅语义只用本地 Embedding 近邻(模型未就绪时结果为空)

模型文件默认放在 ~/.fgbg/shared/embedding/(可用环境变量 MDOCS_EMBEDDING_DIR 改目录),启动后后台下载/加载,不挡服务启动。未就绪时「自动」等价于纯关键词。

#搜索能力

  • 标题优先:标题与正文分两路 FTS;标题命中权重更高
  • 语义补盲:近义、换说法也能命中(需已建语义索引)
  • 中文分词:关键词写入与查询都走 jieba
  • 权限过滤:自动过滤当前访客无权阅读的文档
  • 结果信息:标题、作者、最后修改时间、路径、片段;命中词高亮;可标注标题/正文/语义来源

#语义索引管理

设置页左侧 语义索引:

  • 表格列出可读 Markdown 文档:语义状态、上次语义构建时间、文章更新时间
  • 表头可筛工作空间、是否已建;列可排序;底部分页(每页条数 / 页码可调)
  • 勾选后点「重建所选」写入向量块;也可在工具栏按标题/路径搜索行

文档保存后仍会异步尽力更新语义索引;本页用于补建、重刷或只处理未建文档。

#CLI / Agent

  • search_documents:可选 domainId、mode、topN
  • list_semantic_index / rebuild_semantic_index:查看与重建语义索引

#索引更新(关键词)

  • 文档创建或更新后标记 dirty,异步重建(正文 + 标题两路 FTS)
  • 默认约每 60 秒扫描一次待索引文档
  • 语义失败不回滚 FTS、不清回 dirty