# capybara-mdview **Repository Path**: qianguanshui/capybara-mdview ## Basic Information - **Project Name**: capybara-mdview - **Description**: capybara-mdview 是一个面向快速阅读、专注编辑与轻量文件夹浏览的桌面 Markdown 工作区。你可以只打开一份文档，也可以拖入整个文件夹，并在顶层标签中同时保留多个文件和文件夹，无需为一次简单的阅读启动完整 IDE。应用采用克制、贴近原生桌面软件的界面风格，支持预览、滚动同步的分屏编辑和所见即所得编辑。Markdown 能力由 Vditor 提供，覆盖 GFM、代码高亮、数学公 - **Primary Language**: Unknown - **License**: MIT - **Default Branch**: main - **Homepage**: https://gitee.com/qianguanshui/capybara-mdview - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2026-08-27 - **Last Updated**: 2026-08-31 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README

[简体中文](./README.zh-CN.md) | [English](./README.md) capybara-mdview 图标

# capybara-mdview **适用于 Windows、macOS 和 Linux 的轻量 Markdown 阅读与编辑器** 📖 **舒适阅读** × ✍️ **自由编辑** × 📁 **文件与文件夹工作区** [![Gitee Stars](https://gitee.com/qianguanshui/capybara-mdview/badge/star.svg?theme=gvp)](https://gitee.com/qianguanshui/capybara-mdview) [![GitHub Stars](https://img.shields.io/github/stars/Assassin-Q/capybara-mdview?style=flat-square&logo=github&logoColor=white)](https://github.com/Assassin-Q/capybara-mdview) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](LICENSE) [![Gitee Release](https://img.shields.io/badge/Gitee-Releases-C71D23?style=flat-square)](https://gitee.com/qianguanshui/capybara-mdview/releases)

![capybara-mdview 欢迎页](./docs/images/screenshots/welcome.png)

--- ## 项目介绍 capybara-mdview 是一个面向快速阅读、专注编辑与轻量文件夹浏览的桌面 Markdown 工作区。你可以只打开一份文档，也可以拖入整个文件夹，并在顶层标签中同时保留多个文件和文件夹，无需为一次简单的阅读启动完整 IDE。应用采用克制、贴近原生桌面软件的界面风格，支持预览、滚动同步的分屏编辑和所见即所得编辑。Markdown 能力由 Vditor 提供，覆盖 GFM、代码高亮、数学公式、流程图及常用扩展语法。 --- ## 下载 - [Gitee Releases](https://gitee.com/qianguanshui/capybara-mdview/releases)：国内镜像下载 - [GitHub Releases](https://github.com/Assassin-Q/capybara-mdview/releases)：Windows 安装版、Windows 绿色版与 macOS DMG Linux 用户可以通过源码执行 `pnpm dist:linux` 构建 AppImage。 Windows 安装版、macOS ZIP/DMG 和 Linux AppImage 内置应用内更新。打开“设置 → 版本”即可检查更新、下载并重启安装；Windows 绿色版不覆盖自身，需手动替换新版文件。 --- ## 功能特性 - 打开单个 Markdown 文件或整个文件夹，支持拖拽快速打开 - 顶层标签既可以是文件，也可以是文件夹，并提供标签右键关闭操作 - 虚拟化文件树、文档目录与可搜索、分页的打开历史 - 预览、滚动同步分屏编辑、所见即所得三种模式 - 支持 GFM、代码高亮、KaTeX 数学公式、Mermaid/Flowchart、Graphviz、ECharts 与 Markmap - 新建空白草稿自动缓存，保存时选择本地目录与文件名 - 使用 `Ctrl/Cmd + F` 在当前文档中搜索 - 点击预览图片后可缩放、平移查看 - 浅色、深色与跟随系统主题 - 简体中文、English 与跟随系统语言 - Windows 资源管理器右键菜单和 Markdown 文件关联开关 - 安装版支持应用内检查、下载与重启更新 - 支持 Windows、macOS 和 Linux --- ## 软件截图 | | | |:---:|:---:| | **预览与文件树** | **滚动同步分屏编辑** | | ![预览与文件树](./docs/images/screenshots/preview-file-tree.png) | ![滚动同步分屏编辑](./docs/images/screenshots/split-editor.png) | | **所见即所得编辑** | **文档目录** | | ![所见即所得编辑](./docs/images/screenshots/wysiwyg-editor.png) | ![文档目录](./docs/images/screenshots/outline.png) | | **打开历史** | **欢迎工作区** | | ![打开历史](./docs/images/screenshots/history.png) | ![欢迎工作区](./docs/images/screenshots/welcome.png) | --- ## 快捷键 | 快捷键 | 功能 | |---|---| | `Ctrl/Cmd + N` | 新建文件 | | `Ctrl/Cmd + O` | 打开 Markdown 文件 | | `Ctrl/Cmd + S` | 保存当前文件 | | `Ctrl/Cmd + F` | 在当前文件中查找文本 | | `Ctrl/Cmd + \` | 展开或收起侧栏 | --- ## 技术栈 | 层 | 技术 | |---|---| | 桌面运行时 | Electron 35 | | 前端 | React 18 + TypeScript 5.7 | | 构建工具 | Vite 6 + pnpm | | Markdown 引擎 | Vditor 3.11 | | 图标 | lucide-react | | 打包 | electron-builder | --- ## 本地开发建议使用 Node.js 22+ 与 pnpm 10+。 ```bash pnpm install pnpm dev ``` 质量检查： ```bash pnpm typecheck pnpm build:renderer ``` 桌面端打包： ```bash pnpm dist:win pnpm dist:mac pnpm dist:linux ``` ## 项目结构 ```text capybara-mdview/ ├── electron/ # 主进程、预加载桥接、系统对话框与注册表集成 ├── src/ # React 应用、Markdown 编辑器、工作区界面与样式 ├── docs/images/ # 软件截图与项目支持图片 ├── .github/workflows/ # 跨平台发行工作流 ├── Capybara.svg # 应用图标 └── package.json # 脚本与 electron-builder 配置 ``` --- ## 开源许可 capybara-mdview 使用 [MIT License](./LICENSE) 开源，可自由使用、修改与分发。 --- ## 联系与支持