HedgeDoc完全指南：如何快速搭建基于Yjs的实时Markdown协作编辑器

HedgeDoc是一款开源的实时Markdown协作编辑器，采用Yjs技术实现多人同时编辑的无缝体验。无论您是团队协作、教学演示还是个人笔记，HedgeDoc都能提供出色的编辑和分享功能。

🔥 为什么选择HedgeDoc？

HedgeDoc基于Yjs冲突解决算法，确保多人协作时数据同步零延迟。与传统编辑器不同，它支持：

• 实时协作：多人同时编辑，即时同步
• 双栏预览：左侧编辑，右侧实时渲染
• 多种部署方式：Docker、源码部署、云服务
• 丰富的扩展功能：幻灯片演示、数学公式、图表等

🚀 快速安装步骤

Docker一键部署

最简单的部署方式是使用Docker Compose：

git clone https://gitcode.com/gh_mirrors/server4/server
cd server/docker
docker-compose up -d

源码安装

如果您需要自定义配置，可以选择源码安装：

git clone https://gitcode.com/gh_mirrors/server4/server
cd server
yarn install
yarn build
yarn start

✨ 核心功能介绍

实时协作编辑

HedgeDoc最强大的功能就是实时协作。当多个用户同时编辑同一文档时，所有更改都会实时同步到每个参与者的界面。

Markdown语法支持

支持完整的Markdown语法，包括：

• 标题、列表、引用
• 代码块和语法高亮
• 数学公式（LaTeX）
• 表格和图表
• 任务列表

幻灯片演示

HedgeDoc内置幻灯片功能，只需在文档开头添加特定分隔符，即可将Markdown转换为精美的演示文稿。

🎯 用户体验设计

简洁的界面布局

HedgeDoc采用双栏设计，左侧为编辑区，右侧为实时预览区。这种布局让用户在编写时就能看到最终效果。

便捷的用户管理

系统提供完整的用户注册和登录功能：

• 用户名唯一标识
• 显示名公开可见
• 密码安全验证
• 条款确认机制

🔧 配置与定制

主要配置文件

• 应用配置：backend/src/config/app.config.ts
• 数据库配置：backend/src/config/database.config.ts
• 媒体存储配置：backend/src/config/media.config.ts

自定义主题

通过修改前端样式文件，可以轻松定制界面主题：

• frontend/src/global-styles/variables.light.scss

💡 使用技巧与最佳实践

团队协作建议

1. 权限管理：合理设置文档访问权限
2. 版本控制：利用历史记录功能追踪变更
3. 媒体管理：图片和文件上传优化

📊 性能优化

HedgeDoc采用模块化设计，各功能组件独立：

• 实时通信模块：backend/src/realtime/
• 权限控制模块：backend/src/permissions/
• 用户管理模块：backend/src/users/

🎉 开始使用

HedgeDoc是一款功能强大且易于使用的Markdown协作编辑器。无论您是需要团队文档协作，还是个人知识管理，它都能提供出色的体验。

现在就开始您的HedgeDoc之旅，体验实时Markdown协作的魅力吧！