使用Markdown快速书写技术文档

背景介绍

在设计和开发公司某项目的过程中,通过与同事交谈,了解到目前使用Word作为主要的技术文档制作工具,有以下使用难点

  1. 排版困难,比如:标题、有序列表的调整,都很繁琐,效率低
  2. 格式方面,比如:给代码加语法高亮,Word支持很差。如果截图贴到文档里,易用性、可编辑性都比较差

针对上面的痛点,现在更流行使用MarkDown来书写文档。再配合一些编辑器(比如:Typora),可以很好的解决上面的问题。

Markdown简介

Markdown是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式。

Markdown具有一系列衍生版本,用于扩展Markdown的功能(如表格、脚注、内嵌HTML等等),这些功能原初的Markdown尚不具备,它们能让Markdown转换成更多的格式。例如LaTeX,Docbook。

Markdown增强版中比较有名的有Markdown Extra、MultiMarkdown、 Maruku等。这些衍生版本要么基于工具,如Pandoc;要么基于网站,如GitHub和Wikipedia,在语法上基本兼容,但在一些语法和渲染效果上有改动。

Markdown编辑器

推荐一些我常用的Markdown编辑器

在线编辑器

作业部落:很方便的在线编辑器,支持公式、代码高亮、流程图、序列图等功能,比较完善。只要注册就可以使用。

编辑器软件

Typora:是一款我现在常用的Markdown编辑器,不像一般编辑器分输入窗口和预览窗口。它支持所见即所得编辑文档,还有可以方便的导出PDF、HTML、Word、Epub等十几种格式文档。

当然,Markdown工具还有很多,大家可以选择自己喜欢的来使用。

Markdown教程

推荐一些Markdown教程。

菜鸟教程:内容很详细,知识点分类清晰

最完整的Markdown基础教程:简书上记录的一篇博文,详细介绍了Markdown的常用语法及用法

结束语

Markdown使得书写文档不再困难,最后希望书写技术文档能变成快乐的事儿,就像写代码一样有趣吧!!!

发表评论

电子邮件地址不会被公开。 必填项已用*标注

此站点使用Akismet来减少垃圾评论。了解我们如何处理您的评论数据