# BCY-Markdown **Repository Path**: BraveCao/BCY-Markdown ## Basic Information - **Project Name**: BCY-Markdown - **Description**: 面向 Apple Silicon Mac 的轻量离线 Markdown 阅读、编辑与导出工具 - **Primary Language**: Unknown - **License**: GPL-2.0 - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2026-07-23 - **Last Updated**: 2026-08-09 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # BCY-Markdown BCY-Markdown 是一款面向 macOS 与 Windows 的轻量、离线 Markdown 阅读、编辑和导出工具。文档、图片资源、最近打开记录与恢复草稿均保存在本机;应用不需要账号,不提供云同步、遥测或后台网络服务。 当前源码与 macOS 版本:`1.0.5`;Windows 安装包版本:`1.0.2` ## 平台与发布状态 | 平台 | 系统与架构 | 当前状态 | | ------- | --------------------------------- | ------------------------------------------------------------------------------------ | | macOS | macOS 15+,Apple Silicon(arm64) | 1.0.5 已提供 DMG 与 PKG;应用使用临时签名,PKG 未签名,尚未经过 Apple 公证 | | Windows | Windows 10/11,x64 | 1.0.2 已在实际 Windows 环境完成构建与功能测试;1.0.5 待 Windows 发布机重新构建与验收 | 支持打开和保存 `.md`、`.markdown`、`.mdown`、`.mkd`、`.mkdn` 与 `.txt` 文件。 ## 下载与安装 ### macOS 仓库 [`release/`](release/) 目录提供 1.0.5 安装包及其 SHA-256 校验文件: - `BCY-Markdown_1.0.5_aarch64-installer.dmg` - `BCY-Markdown_1.0.5_aarch64.pkg` 打开 DMG 后运行其中的“安装 BCY-Markdown.pkg”,再按系统提示完成安装。安装器会把应用放入“应用程序”,并仅在 Bundle ID 确认匹配时移除旧名称 `BCY-Makedown.app`,避免启动台和“打开方式”出现重复应用。 当前应用使用临时签名,PKG 安装器未签名,并且尚未经过 Apple 公证。首次安装或打开若被系统阻止,请前往“系统设置 > 隐私与安全性”确认继续。 ### Windows 仓库 [`cn/release/1.0.2/`](cn/release/1.0.2/) 目录提供: - `BCY-Markdown_1.0.2_x64-setup.exe`:NSIS 当前用户安装包,不需要管理员权限 - `BCY-Markdown_1.0.2_x64_zh-CN.msi`:MSI 每台计算机安装包,需要管理员批准 UAC 提升 - `BCY-Markdown_1.0.2_source.zip`:GPL 对应版本源代码包 - `BCY-Markdown_1.0.2_windows_SHA256SUMS.txt`:SHA-256 校验清单 当前 1.0.2 Windows 安装包用于内部测试,采用自签名证书。应用功能已经在实际 Windows 环境完成测试,但尚未包含 1.0.3 的编辑模式本地图片渲染修复、1.0.4 的图片尺寸编辑功能及 1.0.5 的连续调整修复;1.0.5 需要在 Windows 发布机重新构建并验收。该签名不等同于面向普通用户的公开可信签名,公开发布前仍需按[代码签名政策](CODE_SIGNING_POLICY.md)和[Windows 公开发行准备](cn/public-signing-readiness.md)完成 CA 或 SignPath 签名流程。 ## 打开文档 从 Finder、Windows 资源管理器或应用内打开已有文件时,文档会先进入预览模式;需要修改时点击“编辑”。新建文档会直接进入编辑模式。 ### 设置为默认打开程序 - macOS:在 Finder 中选中文件,按 `Command-I` 打开“显示简介”,在“打开方式”选择 `BCY-Markdown`,再点击“全部更改”。 - Windows:在资源管理器中右键支持文件,选择“打开方式 > 选择其他应用”,选择 `BCY-Markdown` 并设为默认应用。 Windows 版支持单实例文件接管:应用已经运行或处于最小化状态时,再次双击支持文件会恢复现有窗口并在新标签页中打开文档,不会重复启动多个应用进程。 ## 主要功能 - 单窗口多标签页,可在多篇文档之间快速切换。 - 左侧栏提供“目录”“大纲”“最近打开”切换;目录按需展开,不会在启动时扫描整个磁盘。 - 支持工作区内新建、重命名、移动、复制和移入废纸篓。 - 支持快速打开、文件名搜索、全文搜索和文档内查找替换。 - 支持恢复草稿、历史快照、原子保存、内容冲突保护和外部修改处理。 - 支持浅色、深色、跟随系统、本地 CSS 设计变量主题、专注模式和打字机模式。 ## 编辑与预览 - 支持 GFM、表格、任务列表、脚注、数学公式、代码高亮、Mermaid 图表和思维导图。 - Markdown 默认使用结构化编辑;无法安全转换的内容会自动进入无损文本编辑,避免破坏原文。 - `.txt` 使用无损文本编辑,保留原有行内容与换行。 - macOS 支持系统拼写检查。 ## 图片与导出 图片可通过文件选择、剪贴板粘贴或拖放导入。应用会校验格式签名、文件大小、SVG 内容和符号链接,并把可用图片保存到文档资源目录;预览和编辑模式都会渲染文档相对路径内的本地图片。编辑模式点击图片后可调整宽度、修改替代文字、恢复原始大小或删除图片。 核心版本支持导出: - 带样式 HTML - 无样式 HTML - Markdown - PDF - PNG macOS 的 PDF/PNG 使用系统 WebKit 渲染;Windows 使用系统 Microsoft Edge 无界面渲染,不会打开可见浏览器窗口。 DOCX、RTF、ePub 和 LaTeX 依赖可选 Pandoc 扩展。核心安装包不捆绑 Pandoc,导入扩展前会校验版本、平台、架构与 SHA-256。当前仓库已提供 macOS arm64 扩展;Windows `pandoc.exe` 仍需完成官方二进制哈希复核并加入白名单后才能启用相关格式。 ## 本地与安全边界 - 仅处理用户明确选择、由系统打开或位于已授权工作区内的文件。 - 不支持的扩展、符号链接越界、未授权路径和不安全导出目标会被拒绝。 - 不加载远程图片、脚本、网络字体和外部主题资源。 - 主题只能覆盖受控设计变量;图片和导出均有大小限制与失败保护。 - Windows 发布脚本支持 Authenticode 状态、签名证书指纹和 SHA-256 清单校验。 ## 开发与验证 公共开发环境需要 Node.js 20+ 和 Rust stable: ```bash npm ci npm run test:run npm run build cargo test --manifest-path src-tauri/Cargo.toml --locked cargo fmt --manifest-path src-tauri/Cargo.toml --check ``` 启动开发版: ```bash npm run tauri dev ``` ### 构建 macOS macOS 构建还需要 Xcode Command Line Tools: ```bash npm run tauri build -- --target aarch64-apple-darwin --bundles app ./scripts/build-macos-installer.sh ``` 安装器、DMG 和 SHA-256 文件位于根目录 `release/`。为避免 macOS 把项目构建产物登记成第二个应用,安装器脚本成功完成后会注销并删除临时 `.app`;需要保留临时应用进行开发验收时,使用 `KEEP_BUILD_APP=1 ./scripts/build-macos-installer.sh`。 ### 构建 Windows Windows 构建需要 Rust stable MSVC、Microsoft C++ Build Tools、Windows SDK、WebView2 和 Microsoft Edge。在仓库根目录的 Windows PowerShell 中执行: ```powershell pwsh.exe -NoProfile -ExecutionPolicy Bypass -File .\cn\build-windows.ps1 ``` 内部测试签名构建与证书信任方式见 [`cn/internal-signing.md`](cn/internal-signing.md)。公开签名前可运行: ```powershell pwsh.exe -NoProfile -ExecutionPolicy Bypass -File .\cn\public-signing-preflight.ps1 -RequirePublicRepository ``` Windows 发布脚本会生成 NSIS `.exe`、中文 MSI `.msi`、对应源代码 ZIP 和 SHA-256 清单,并复制到 `cn\release\<版本>\`。完整人工验收项目见 [`cn/windows-acceptance.md`](cn/windows-acceptance.md)。 ## 仓库结构 - `src/`:React 前端与编辑器界面 - `src-tauri/`:Tauri/Rust 桌面端、文件系统、安全和导出实现 - `scripts/`:macOS 构建、安装和扩展打包脚本 - `cn/`:Windows 构建、签名、发布和验收文件 - `release/`:macOS 安装包、校验文件和可选扩展 - `cn/release/`:Windows 安装包、源代码包和校验清单 根目录 README 是 macOS 与 Windows 的统一使用说明,`cn/` 不再维护第二份 README,避免两份文档内容不同步。 ## 许可证与发布 项目代码按 [`GPL-2.0-only`](LICENSE) 发布。允许收费分发,但分发二进制时必须同时提供许可证与完整对应源代码;如需闭源专有授权,必须先取得全部相关权利人的书面授权。 公开源码仓库:[Gitee BraveCao/BCY-Markdown](https://gitee.com/BraveCao/BCY-Markdown)。仓库不应包含访问令牌、私钥或个人凭据;发布凭据应保存在操作系统凭据管理器或 CI 密钥存储中。