Ornata

Ornata 是一个基于 Tauri、React 和 CodeMirror 6 的桌面 Markdown 编辑器，目标不是做成通用 IDE，而是做成“写作优先、性能可信、视觉克制”的创作工具。

Language

• 简体中文（当前）: README.md
• English: README.en.md

当前状态

• 项目处于活跃开发中，核心方向是提升 WYSIWYG 稳定性、继续拆分巨型入口文件，以及补强回归与发布约束。
• 仓库已经具备基础测试、前端构建和 Tauri/Rust 编译能力。
• 仓库采用 GNU Affero General Public License v3.0 only（AGPL-3.0-only）。

功能方向

• 高性能 Markdown 编辑与预览
• Typora 风格的 WYSIWYG / Markdown 混合体验
• 面向技术写作者的代码块、Mermaid、KaTeX、Git 辅助能力
• 可导入主题、工作区管理、桌面端导出与自动更新能力

技术栈

• Tauri 2
• React 19
• TypeScript
• CodeMirror 6
• Shiki
• Mermaid
• KaTeX
• styled-components
• Bun

开发前提

开始之前请先准备：

• Bun 1.2+
• Rust stable
• 平台对应的 Tauri 依赖
• macOS: Xcode Command Line Tools
• Windows: WebView2
• Linux: WebKitGTK 等 Tauri 所需系统包

本地开发

安装依赖：

bun install

启动前端开发服务器：

bun run dev

启动桌面端：

bun run tauri dev

运行单元测试：

bun run test

运行前端验证：

bun run verify

运行 Rust 编译检查：

cd src-tauri
cargo check

目录概览

• src/App.tsx：当前主应用入口，仍在持续拆分
• src/editor：编辑器扩展、WYSIWYG 渲染与交互逻辑
• src/features：逐步抽离出来的功能模块
• src-tauri：Tauri / Rust 命令与桌面端能力
• docs/update_log.md：版本更新记录
• docs/release-process.md：发布流程
• docs/open-source-readiness.md：开源前检查清单与 fork 注意事项

官方基础设施

这个仓库包含 Ornata 官方发布链路里用到的域名、更新地址和 Homebrew tap 约定。fork 时请优先替换下列内容：

• 官网入口：https://ornata.app/
• 更新端点：https://github.com/08820048/Ornata/releases/latest/download/latest.json
• Homebrew tap 仓库与 cask 输出目标

详细说明见：

• docs/open-source-readiness.md
• docs/release-process.md
• docs/homebrew.md

贡献与协作

• 贡献说明：CONTRIBUTING.md
• 行为准则：CODE_OF_CONDUCT.md
• 安全说明：SECURITY.md

开源许可证

• 本项目基于 GNU Affero General Public License v3.0 only 开源，SPDX 标识为 AGPL-3.0-only。

安全与隐私

• 当前仓库里没有配置遥测或分析服务。
• 最近文件、界面偏好、恢复草稿等数据会保存在本地设备。
• 图片上传相关的本地配置需要额外留意，详见 SECURITY.md。

发布说明

版本号需要同步更新以下位置：

• package.json
• src-tauri/tauri.conf.json
• src-tauri/Cargo.toml
• docs/update_log.md

完整发布流程见 docs/release-process.md。