比较应用Markdown和XML写文档
比较使用Markdown和XML写文档
简介
今天参与一技术讨论,得知有一种写文档的工具叫做Markdown。今天简单看了一下,总结如下。因无Markdown大量使用经验,观点不对敬请指教。
注:我从事基于XML编写文档相关软件开发多年,所以不自觉地将Markdown与XML进行比较。
优点
- 简单
在我看来最最重要的优点。一般用户经过简单学习即可上手,技术人员上手更快。我5分钟之内可以使用Markdown写文档。这样能让大量用户来使用。
- 基于文本
编写XML文档,绝大多数人需要借助专业的编辑器。Markdown基于纯文本, 有很多开源的编辑器。成本大大降低。
- 所见即所得
很多Markdown编辑器都带所见即所得编辑。左边是原文本,右边是效果。
缺点
- 文档结构
无目录生成功能。
- 格式化是命令有限
无中划线,背景颜色处理,下划线,上脚标,下角标的格式化命令。
- 特殊字符处理
无类似于Word中插入特殊字符的功能。
- 无序列表
无控制无序列表符号的命令,需要客户化CSS。
- 有序列表
无控制序列编号类型的命令。
- 表格
无表格
- 图形
不能控制图形大小
- 变更跟踪
不能实现变更跟踪和变更文字高亮显示功能。
- 无元数据
此问题使文档很难被计算机再度处理和“理解”。即无智能。
无表示语义的方法。
- 输出
设计是针对HTML输出的。作者在设计格式化命令时,考虑的是怎样在HTML里格式化。不合适纸面输出和其他方式输出。
总结
Markdown非常适合于在线编辑文档和HTML展示。以上缺点可能不能算作缺点,因为作者设计的时候有它应用的场景。
编辑和出版技术文档手册,则XML更适合一些。
注:此文档使用Markdown编写