MDBook 本地 Markdown 笔记与知识管理软件

项目类型：Windows 桌面应用、本地化知识管理工具

开发内容：产品功能设计、桌面端开发、编辑器集成、文件管理、Git 数据同步、安装包构建与自动化测试

MDBook 是一款以本地文件为核心的 Markdown 笔记与知识管理软件，面向技术文档、项目资料、工作记录及个人知识库等使用场景。软件将笔记直接保存为通用的 Markdown 文件，用户可通过文件夹自主管理资料，不被特定平台或专有数据库绑定，兼顾编辑效率、数据可迁移性与长期使用需求。

项目背景

在日常办公和软件开发过程中，技术文档、项目方案、会议纪要及相关附件往往分散在不同目录和工具中，存在资料查找不便、文档格式不统一、文件迁移困难以及版本记录不清晰等问题。

针对这些需求，我们设计并开发了 MDBook，将 Markdown 编辑、笔记库管理、办公附件关联、图表展示、全文搜索和 Git 版本同步整合到统一的桌面工作界面中，为用户提供轻量化、可持续维护的本地知识管理方案。

解决方案

软件采用“本地笔记库加标准 Markdown 文件”的管理方式。用户可指定任意文件夹作为笔记库，按项目或业务分类建立多级目录，文档、图片和附件均以真实文件形式保存。即使不使用本软件，也可以通过普通文本编辑器或其他 Markdown 工具读取和迁移资料。

围绕日常编辑与资料管理流程，软件提供浏览、纯源码和所见即所得三种文档模式，并将图片、办公附件与文档通过相对路径建立关联，使整个笔记库可以方便地备份、复制和纳入 Git 版本管理。

核心功能

三种文档使用模式

• 浏览模式以排版后的网页形式展示已有文档，便于阅读和复制富文本内容。

• 纯源码模式提供代码高亮、快捷格式操作和图表预览，适合技术文档编写。

• 所见即所得模式支持直接编辑排版内容，降低 Markdown 的使用门槛。

完整的 Markdown 编辑能力

• 支持多级标题、粗体、斜体、删除线、引用、列表、任务列表、链接、表格、代码块及分割线。

• 提供常用编辑快捷键、代码块语法高亮和可调整的编辑器字号。

• 支持图片导入及粘贴上传，图片自动保存到笔记库并生成相对路径。

• 支持 Mermaid 流程图和脑图，满足技术方案、业务流程及知识结构的可视化表达。

办公附件与文档关联

• 支持 DOC、DOCX、XLS、XLSX、PPT、PPTX、PDF、TXT、CSV、WPS、ZIP、RAR、7z 等常见办公文件和压缩包。

• 上传时可选择目标目录，文件统一保存到该目录下的附件文件夹，支持批量上传和同名文件自动编号。

• 在编辑器中上传附件后，自动向当前 Markdown 文档插入关联链接，跨目录引用也能生成正确的相对路径。

• 浏览文档时可点击附件链接，通过系统默认程序打开；附件移动或重命名后，相关文档链接自动更新。

高效的笔记库管理

• 支持多级目录、新建笔记和文件夹、拖动移动、重命名及回收站删除。

• 支持按文件名、文件夹名和 Markdown 正文搜索，并显示匹配内容的行号与摘要。

• 自动记忆上次打开的笔记库、当前文档、编辑模式和自动保存设置。

• 支持临时编辑外部 Markdown 文件，也可将其导入当前笔记库。

Git 版本同步与数据保护

• 支持 Git 仓库初始化、手动提交、拉取、推送和定时自动同步。

• 文档、图片和附件均可纳入版本管理，文件移动、重命名和删除操作能够形成对应的变更记录。

• 笔记始终保存在用户指定的本地目录中，结合 Git 可进一步实现版本追踪和多端资料同步。

集成实用工具

• 提供 HTML 与 Markdown 双向源码转换，便于内容迁移和格式整理。

• 集成时间与时间戳转换、随机 Token 生成、MD5 和 SHA 系列哈希计算等开发工具。

• 支持多套界面主题、Windows 文件关联、可选开机自启动及定时关机提醒。

技术实现

软件采用 Tauri 2 与 Rust 构建桌面端和本地文件服务，前端使用 Vue 3、TypeScript 与 Vite，集成 CodeMirror 6 和 Milkdown 编辑器，并通过 Mermaid 实现流程图和脑图展示。

相比传统 Electron 桌面应用，Tauri 利用系统 WebView 和 Rust 后端，在保持现代界面开发效率的同时，降低安装包体积和运行资源占用。文件路径校验、附件格式限制、二进制文件导入和 Git 操作均由后端处理，避免将办公附件误读为文本，并限制文件操作范围在用户指定的笔记库内。

交付与质量保障

项目提供 Windows 独立运行程序和 NSIS 安装包，并生成 SHA-256 校验文件，便于软件分发和完整性验证。开发过程中针对文件读写、中文文件名、附件重复导入、目录移动、附件链接更新及 Git 同步等关键流程建立了自动化测试，保障主要功能的稳定性。

应用价值

MDBook 将零散的文档、图片和办公附件组织为结构清晰、可持续维护的本地知识库，在保留 Markdown 通用性的同时，提供接近常规办公软件的编辑和资料管理体验。

该方案适用于开发团队技术资料管理、项目文档归档、个人知识库建设及需要本地保存和版本同步的办公场景，也可根据企业实际需求进一步扩展权限管理、团队协作、模板管理和内部系统集成等功能。