Markdown 编辑器

ulthon-document 的 Markdown 编辑器基于 editor.md 构建,适合写技术文档、产品说明、教程这类以文字为主的内容。无需关心排版,专注内容本身。

支持的语法

标准 Markdown 语法

  • 标题(H1 到 H6)
  • 有序列表、无序列表
  • 链接和图片
  • 表格、引用、粗体、斜体
  • 行内代码和代码块

扩展语法

  • 流程图:用 flow 代码块编写
  • 时序图:用 sequence 代码块编写
  • 任务列表:- [x] 表示已勾选,- [ ] 表示未勾选
  • 代码块带语法高亮

图片上传

工具栏带图片按钮,支持 jpg、png、gif、webp、bmp 五种格式。点击后从本地上传,自动插入到光标位置,不用手动写图片语法。

编辑和预览

默认左右分栏,左边写、右边实时预览。两边滚动条联动,写长文档时不会丢失阅读位置。需要专注写作时可以切到全屏编辑,需要核对效果时切到全屏预览。

适合的场景

  • API 文档、技术手册
  • 教程和操作指南
  • 项目说明、版本更新日志
  • 任何以文字和代码为主的页面

原文标题:Markdown 编辑

原文文档:奥宏文档

原文地址:/read/augushong/ulthon-document/zh-cn/1.0.0/content-editing/markdown-editing.html

原文平台:奥宏文档

1.0.0