什么是 Markdown?
Markdown 是一种轻量级标记语言,由 John Gruber 于 2004 年创建。它使用易于阅读和编写的纯文本格式来创建结构化文档,并将其转换为有效的 HTML。Markdown 广泛应用于技术文档、博客文章、README 文件、在线帮助系统等场景。由于其简洁的语法和优秀的可读性,Markdown 已成为开发者和技术写作者的首选文档格式。
📋 常用语法速查表
# 标题一级标题## 二级标题**粗体**加粗文本*斜体*- 列表项无序列表1. 有序项> 引用引用文本---[链接](url)超链接\`代码\`行内代码``` 代码块| 表头 |表格|------|- [ ] 任务任务列表- [x] 已完成📋 扩展语法支持
- 数学公式 - 支持 KaTeX 渲染,使用 $ 包裹行内公式,$$ 包裹块级公式
- Mermaid 图表 - 支持流程图、时序图、甘特图等 10+ 种图表类型
- 表格合并 - 支持对齐方式设置(左对齐、居中、右对齐)
- 删除线 - 使用 ~~文本~~ 包裹内容实现删除线效果
- 脚注 - 使用 [^1] 语法添加脚注说明
- 任务列表 - 使用 - [ ] 和 - [x] 创建可交互的任务清单
💡 使用建议和最佳实践
- 使用清晰的标题层级组织文档结构,避免跳过标题级别
- 代码块建议标注编程语言类型以获得正确的语法高亮
- 图片使用相对路径或 CDN 链接,避免使用本地路径
- 长文档建议使用目录功能(点击工具栏目录按钮)
- 导出 PDF 时,在打印对话框选择"另存为 PDF"可获得最佳效果
- 定期使用导出功能备份文档,防止数据丢失
工具介绍
Markdown 编辑器是一款功能强大的在线 Markdown 实时预览编辑器,支持代码高亮、数学公式(KaTeX)、Mermaid 图表、任务列表等丰富功能。无论是技术文档、博客文章、README 文件还是学习笔记,都能轻松应对。内置丰富的工具栏快捷按钮,一键插入常用 Markdown 语法,支持导出为 MD、HTML 和 PDF 格式,是写作和文档排版的得力助手。
使用方法
- 1开始编辑
在左侧编辑器中输入 Markdown 文本,或使用工具栏中的快捷按钮插入格式化内容。编辑器支持代码高亮、自动补全和快捷键操作。
- 2实时预览
点击右上角的"预览"按钮可查看渲染后的 HTML 效果。支持标准 Markdown 语法以及扩展语法,包括数学公式、Mermaid 图表、任务列表等。
- 3导入图片
粘贴图片时会自动弹出上传提示,支持拖拽上传图片。图片会被转换为 Base64 格式嵌入文档,方便离线使用和分享。
- 4导出文档
点击工具栏的"导出"按钮,可选择导出为 Markdown (.md)、HTML (.html) 或 PDF 格式。导出 HTML 时会保留编辑器中的所有样式和格式。
使用技巧
- 使用工具栏中的<strong>快捷按钮</strong>快速插入常用 Markdown 语法,提高编辑效率
- 支持<strong>键盘快捷键</strong>:Ctrl+B 粗体、Ctrl+I 斜体、Ctrl+K 链接等
- 导出 PDF 时,在打印对话框中选择<strong>"另存为 PDF"</strong>可获得最佳效果
- 粘贴图片时会自动转换为 Base64 格式嵌入文档,<strong>所有处理均在浏览器本地完成</strong>
- 使用<strong>目录功能</strong>可以快速导航长文档的各个章节
- 代码块建议标注<strong>编程语言类型</strong>以获得正确的语法高亮效果
常见问题
Markdown 编辑器支持哪些扩展语法?
支持标准 Markdown 语法以及多种扩展语法,包括:数学公式(KaTeX)、Mermaid 流程图/时序图/甘特图、任务列表、表格对齐、删除线、脚注、代码块语言标识等。
导出的 PDF 质量如何?
导出的 PDF 基于浏览器打印功能生成,支持 A4 纸张尺寸,自动处理分页和页边距。建议在打印对话框中选择"另存为 PDF"选项,并勾选"背景图形"以获得最佳效果。
编辑器支持多人协作编辑吗?
当前版本暂不支持实时多人协作编辑。您可以导出文档后通过其他方式分享和协作。未来版本可能会加入云同步和协作功能。
我的文档数据安全吗?
完全安全。所有编辑和导出操作均在浏览器本地完成,您的文档内容不会上传到任何服务器。导出图片也使用 Base64 格式嵌入,不依赖外部资源。