hackmdio/hackmd

CodiMD

CodiMD 支持多人实时协作编辑 markdown 文档。它基于 HackMD 源码开发，让你能快速、轻松地部署实例，自主掌控团队内容数据。

!CodiMD 界面截图

关于 HackMD

HackMD 旨在帮助开发者撰写优质文档，通过开放协作构建活跃社区。其核心理念是 用户拥有并掌控所有内容，具体体现在：

• 支持 一键导出所有在线内容；
• 内容格式可移植（因此选择 markdown 作为标准）；
• 可通过 HTML、幻灯片模式 自定义内容展示形式。

CodiMD：开源版 HackMD

CodiMD 是 HackMD 的自由软件版本，由 HackMD 团队开发并开源，功能上略有精简（不含书籍模式）。你可以将 CodiMD 用于社区协作，完全拥有数据主权（名称由来可参考 此处）。

CodiMD 适合开放社区使用，而 HackMD 则侧重权限与访问控制，更适用于商业场景。HackMD 团队承诺 CodiMD 持续开源，欢迎所有贡献！

文档指南

完整文档可参考：CodiMD 文档

部署方式

• 快速启动：如需立即搭建实例，推荐 Docker 部署；
• 参与开发：若计划贡献代码，建议从 手动部署 开始。

配置选项

CodiMD 支持高度自定义，配置项涵盖网络、安全、性能、资源、权限、隐私、图片存储及认证等，详情见 CodiMD 配置指南。

升级与迁移

• 版本升级：从旧版本升级 CodiMD，参考 升级指南；
• 数据迁移：从 Etherpad 迁移数据，可按 迁移指南 操作。

开发者资源

加入贡献者社区，可按以下步骤开始：

1. 手动部署 CodiMD；
2. 配置数据库连接；
3. 了解 项目结构；
4. 使用 webpack 构建修改内容。

贡献与交流

欢迎各类贡献，提问也是一种支持！

浏览器支持

CodiMD 基于 Node.js 运行，用户通过浏览器访问。支持以下浏览器版本：

• Chrome ≥ 47（含 Android 版）
• Safari ≥ 9（含 iOS Safari ≥ 8.4）
• Firefox ≥ 44
• IE ≥ 9、Edge ≥ 12
• Opera ≥ 34（不支持 Opera Mini）
• Android 浏览器 ≥ 4.4

建议订阅 发布更新 feed 以获取最新版本信息。

许可证

采用 AGPL 许可证。