使用Markdown写文档心得

2015/10/15

对于后者我没有任何怨言, linux下面我是vim控。 几乎所有的配置文件都是文本, 但在linux环境下如果给我doc我估计要杀了他。linux的黑白终端,是vim肥沃的土壤。 但很多情况下, 别人给我文档我都是在windows word中查看, 然后一点一点的复制过去, 这就必须的让我抛不开鼠标的标记。这样下来vim和notepad有什么有事可谈? 信手拈来的快捷键也无用武之地。 所以这是我喜欢markdown的一个理由。

但仅仅这样不足以说明markdown的诱惑之处。

我们可以设想一下, 当你的word文档需要发布的时候, 你是考虑通过doc发布还是pdf发布, 还是其他主流的mht? 不管怎样发布首先你都要有word等富文本编辑器。然后各种转换工具, doctopdf, pdftodoc等等, 而且这种工具几乎都是在使用的时候才想起来安装一个, 用了一次之后甚至几个月都不会再用一次。

浪费精力 浪费时间 浪费资源。

而这些markdown全都给你解决了, 一般markdown编辑器都有转成html的功能, 直接发给他们一个html网页文档, 一样可以给客户很好的展现。当然如果你想发布文档, 可以用pandoc转换下, N多格式总有一个是你想要的。 而我发布一般都是markdown 文件, 这样得到的人就能好好了解md的语法格式, 如果喜欢最好,可以很方便的阅读了,增长md语法知识, 如果不喜欢也没关系, 精简的语法不会影响内容的阅读。

还有一个可能会被认为缺点的优势, 纯文本格式,相比HTML超文本不同的是markdown语法简单多了, 相同的是图片都是需要外链的。有人说这个很麻烦,还要找图床, 每次上传拷贝连接地址太麻烦 而我觉得这个恰好让我们的文章的图片都集中化了, 拷贝链接地址不是理由, 要知道用富文本可是要点N多次鼠标的, 同样是编辑我现在我可是手放键盘标准姿势眼神平顺一心一意在写。 我这个人是键盘控, 所以喜欢了vim等工具,只要有快捷键绝不用鼠标。

所以我总结了markdown的优缺点:

优点

  • 语法简洁
  • 简单、轻量级
  • 标签有行业标准
  • 应用广泛(GitHubRedditStackOverFlowJianShu)
  • 相应的工具支持很好。(pandoc、sublime Text 2)
  • 专注你的文字内容而不是排版样式。
  • 纯文本内容,兼容所有的文本编辑器与字处理软件。
  • 可读,直观。适合所有人的写作语言。

缺点

  • 表格实现需要html代码(解决方案)
  • pandoc没有图形界面

Markdown 官方文档

这里可以看到官方的 Markdown 语法规则文档,当然,后文我也会用自己的方式,阐述这些语法在实际使用中的用法。

我该用什么工具?

Mou Markdown editor for developers

在 Mac OS X 上,我强烈建议你用 Mou 这款免费且十分好用的 Markdown 编辑器,它支持实时预览,既左边是你编辑 Markdown 语言,右边会实时的生成预览效果,笔者文章就是 Mou 这款应用写出来的。

Mou Markdown editor for developers

鼓励初学者多用 Markdown 写作

说到底,Markdown 再好,用户肚子里没货,或者没有书写表达的愿望,一切都是空谈。Markdown 只是工具,用来提升书写效率,所以首先要让用户产生表达的愿望,然后再用 Markdown 来书写,这个可以使用工具来解决一部分问题。譬如,编辑器做得巨牛,各种流畅,敲击感,让用户只想不停的写。渲染效果巨牛,标题特大,字体超正,分隔符巨性感,用户没写几个字,渲染得就像准备送付铅字印刷的的巨著,所以用户只想真的写一部巨著出来,最后就是帮助用户发布文稿。再好的文字,对于作者来说,成就感来自于被读者欣赏,认同的那一刻。

上一篇:最详细的Vi编辑器使用指南 下一篇:github使用简要说明