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

快速开始

安装
第一个知识库

AI 与 Agent

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

核心概念

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

使用指南

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

部署与配置

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

Write freely. Never lose a word.

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

#客户端壳(Android / 桌面)

mdocs 本体是网页应用,用浏览器访问即可。如果你想要一个独立的应用图标 / 窗口 —— 手机上像原生 App 一样打开、桌面上不占浏览器标签 —— 可以用仓库里提供的两个套壳客户端。

两个壳做的事完全一样:内置一个 WebView,加载你自部署的 mdocs 服务器地址。

Android桌面
平台Android 手机 / 平板macOS、Windows
内核Android WebViewWKWebView(macOS)/ WebView2(Windows)
分发侧载 APK(不上架商店)自行构建(不发布安装包)
服务器首次打开自填首次打开自填

两者都不参与 pnpm build,也不在 npm 包内(@fgbg/mdocs 的 files 不含 android/ desktop/)。改壳只影响壳。

壳只是容器,功能全部来自服务器。 升级 mdocs 服务端后,壳不需要重新构建。

#共同点:填服务器地址

首次打开会要求填写你的 mdocs 地址,例如:

  • 局域网:192.168.1.8:4000
  • 公网 + 域名:https://mdocs.example.com

⚠️ 不要在另一台设备上填 127.0.0.1。 那指的是「这台设备自己」。手机或另一台电脑上必须填服务器的真实可达地址。

前提是该设备能访问到那台服务器(同一 Wi-Fi、VPN 或公网)。公网部署建议配 HTTPS,见反向代理示例。

#刷新与更换服务器

  • 刷新:用页面内的「拉取更新」;桌面版菜单里也有「刷新」
  • 更换服务器:Android 长按桌面图标 →「更换服务器」;桌面版菜单 →「更换服务器」

#从浏览器跳回壳

复制文档链接(形如 …/#/doc/<id>)后切回壳,会直接打开该文档。


#Android

#环境

只装最小 SDK(约 500 MB),不需要 Android Studio,也不需要模拟器:

  • JDK 17
  • Android SDK:cmdline-tools、platform-tools、platforms;android-34、build-tools;34.0.0

#构建

cd android
./gradlew assembleDebug

产物:android/app/build/outputs/apk/debug/app-debug.apk

把 APK 拷到手机安装,首次需允许「未知来源」。

assembleRelease 使用 debug 签名,同样可侧载。


#桌面

一套源码同时出 macOS 和 Windows。

#环境

  • Rust:rustup(建议 --profile minimal)。新终端找不到 cargo 时先 source "$HOME/.cargo/env"
  • Node:在本目录单独 npm install,不碰仓库根的 pnpm-lock.yaml
  • macOS:有 Command Line Tools 即可,不必装完整 Xcode
  • Windows:MSVC 构建工具 + 系统 WebView2(Win10/11 通常自带)

#构建(macOS)

在 desktop/ 目录:

npm install
npx tauri build --bundles app

产物:

  • src-tauri/target/release/bundle/macos/mdocs.app
  • 若启用 dmg:src-tauri/target/release/bundle/dmg/mdocs_*.dmg

把 .app 拖进「应用程序」。首次可能提示未签名,去「系统设置 → 隐私与安全性」允许。

#构建(Windows)

必须在 Windows 电脑上构建(WebView2 安装包无法从 macOS 交叉编译):

npm install
npm run tauri build

产物:src-tauri/target/release/bundle/nsis/mdocs_*-setup.exe


#要不要用壳?

你的情况建议
只是用 mdocs浏览器访问即可,不需要壳
想要手机主屏图标 / 桌面独立窗口按上面构建对应平台
想改壳的界面或行为只动 android/ 或 desktop/,与主工程解耦