支持 GFM 的实时分栏 Markdown 编辑器。
使用拆分窗格反馈编写和预览 Markdown,以便在发布到存储库、wiki 或开发人员门户之前可以快速查看文档、变更日志和技术说明。
当您编辑源文本以进行即时语法验证时,它将 Markdown 呈现为格式化输出。
它支持一页中的标题、列表、代码块、表格和链接的实用创作工作流程。
它允许团队在提交文档更改之前验证最终结构,从而帮助减少发布错误。
基础 Markdown
# 发行说明\n\n- 添加了 API 重试\n- 修复了令牌刷新错误
代码块
```bash\nnpm run build\n```
表格示例
|指标|值|\n|---|---|\n|p95|210ms|
渲染的标题/列表
具有适当间距的结构化标题和项目符号输出。
渲染的代码块
使用语言提示样式保留的等宽围栏块。
导出注意
根据目标工作流程复制 Markdown 源或 HTML 输出。
表格对齐方式损坏
确保每行保持相同的列数。
代码块不渲染
用成对的三个反引号正确关闭代码围栏。
意外的 HTML 输出
检查目标渲染器不支持的语法扩展。
链接预览不匹配
发布前确认绝对链接路径与相对链接路径。
Markdown 预览 应作为交付流程中的快速校验步骤,在提交、发布和交接前都建议执行一次。
是否支持 GitHub 风格的 Markdown?
支持核心语法,但发布前仍应在目标平台验证特定扩展。
我应该复制 Markdown 源还是 HTML 输出?
如果目标系统接受 Markdown,就复制 Markdown;嵌入富文本或导出页面时再使用 HTML。
为什么发布后格式会有所不同?
渲染器会有所不同,因此请在最终平台中测试关键文档。
这可以取代文档检查吗?
不能。使用预览来提高创作速度,并保持 CI 检查以执行策略。