Markdoc icon

Markdoc

Markdoc 是协作式 Markdown 编辑器,支持源码与预览同步、实时共同编辑、评论、建议和版本历史;可连接 GitHub gist 与仓库打开文件并发布提交,需 GitHub 账号。

Markdoc

协作式 Markdown 编辑

Markdoc 是面向团队或个人的协作式 Markdown 编辑器,适合需要共同编写、审核和维护 Markdown 文档的用户。它将面向代码的源码编辑器与渲染后的预览结合起来,让用户编辑时两个视图保持同步。

该产品支持实时协作、锚定式审核线程、跟踪建议和版本历史。Markdown 文件可以从 GitHub gist 或仓库打开,然后作为提交发布到选定分支。主页介绍了离线编辑功能,并会在重新连接后同步。

主要功能

源码与预览同步

代码编辑器和渲染后的 Markdown 预览并排显示。编辑任一界面都会为所有协作者更新另一界面,并同步显示光标。

实时协作

在线状态指示器、实时光标和选区支持同时编辑;无冲突合并可处理并发更改。

上下文评论

评论线程可以锚定到文本,并在文档变化时继续跟随相关文字。参与者可以回复、解决和重新打开评论线程。

跟踪建议

建议模式会将提议的编辑记录为跟踪更改。文档所有者可以逐条或一次性接受或拒绝建议。

版本历史

自动快照、命名版本、词级差异比较和一键恢复为文档更改提供记录。

原生 GitHub 存储与发布

可以从 GitHub gist 或仓库打开 Markdown 文件,并将发布内容作为提交创建到选定分支。

使用场景

  • 编写 Markdown 文档

    在同时查看源码语法和渲染结果的情况下,起草和完善 README 文件、文档页面或其他 Markdown 文件。

  • 共同编写文档

    与需要查看在线状态、光标和选区的协作者共同编辑同一文档,同时实时合并更改。

  • 结构化编辑审核

    审核拟议的措辞或结构更改,而不直接替换当前文本;所有者可以接受或拒绝跟踪建议。

  • 上下文反馈

    通过评论线程讨论特定段落;即使文档不断变化,评论线程仍会附着在相关文字上。

  • 维护文档历史

    在发布更新前,使用快照、命名版本、词级差异比较和一键恢复来恢复或比较早期状态。

Pros and Cons

Pros

  • 将可编辑的 Markdown 源码与渲染后的预览结合在同一个同步工作区中。
  • 支持通过在线状态、实时光标和无冲突合并进行同时编辑。
  • 通过锚定评论和跟踪建议提供审核工作流。
  • 通过词级差异比较和恢复功能维护自动版本与命名版本。
  • 通过在选定分支上创建真实提交,将内容发布到 GitHub gist 或仓库。

Cons

  • 产品说明其在预览期间免费,但现有来源未说明预览结束后的定价或任何套餐限制。
  • 主页确认支持 GitHub 身份验证和基于 GitHub 的文件工作流,但未说明更广泛的账户、浏览器或设备要求。

FAQ

什么是 Markdoc?

Markdoc 是一款共享式 Markdown 编辑器,左右并排显示代码编辑器和渲染后的预览。在任一界面中进行的更改都会实时同步给所有人。

用户如何登录?

源页面称 Markdoc 支持使用 GitHub 进行身份验证。页面未提供更多设置或账户要求。

Markdoc 如何与 GitHub 配合使用?

用户可以从 GitHub gist 或仓库打开 Markdown 文件。发布时会在用户选择的分支上创建一次真实提交。

协作者可以审核并提出修改建议吗?

Markdoc 支持评论、回复、解决和重新打开评论线程;还支持建议模式,文档所有者可以接受或拒绝跟踪的编辑。

Markdoc 支持离线使用吗?

主页说明 Markdoc 支持离线工作,并会在连接恢复后同步更新。其他浏览器、设备和平台限制未作说明。

Quick Facts

类别
生产力工具;开发者工具
主要格式
Markdown
身份验证
需要 GitHub 账号
存储与发布
GitHub gist 和仓库;提交到选定分支
协作
实时编辑、评论和跟踪建议
可用性说明
预览期间免费