XRLAB

A Laboratory Focus on Intergrated Disaster Risk Reduction and Resilience by Applying 3S and 3R Technology

【软件】markdown入门及学术写作

Bingwei Tian / 2021-04-11


第一部分 Markdown

本书目标

  • 一本介绍git的markdown书
  • 一本介绍防灾减灾的markdown书
  • 一本供XRLAB实验室使用的markdown参考书

前言

互联网大数据时代,大家都开始将笔记记录在云端,你是否在记录笔记的时候还在选中 =》调整格式 =》调整段落;好吧,你OUT了,MarkDown是一种能快速规范格式的语法,只要几个小小的标识符即可飞快的完成格式化笔记,而且支持各类浏览器直接阅读。 在每个CODE项目中,都会标配一个文件叫readme.md的文件,来说明程序是干什么的。

第一章 什么是markdown (WHAT)

本章主要让大家了解 Markdown 是什么。 Markdown 是目前互联网上最流行的写作语言,它使用一些简单的符号(* / ` > [] () #)来标记文本格式,其简洁的语法、优美的格式以及强大的软件支持深受广大网友的喜爱。 ## 定义 > 维基百科上对 Markdown 的描述: ” Markdown 是一种轻量级标记语言,创始人是约翰·格鲁伯(John Gruber)(博客)。它允许人们 “使用易读易写的纯文本格式编写文档,然后转换成有效的 HTML 文档。”

学习曲线

大家千万不要被一些专业术语唬住了,其实 Markdown 之所以流行,最主要的原因就是因为它的学习门槛很低,你可能只需花几分钟就可以入门了。学习曲线非常平缓,学习起来极其友好。

发展历史

目前现状

  • 网页方面
  • 文档方面

第二章 为什么学用Markdown (WHY)

为什么要用 Markdown? 回想一下我们在写作的时候会遇到什么样的问题?

*格式不兼容:从网上复制一段文字到 Word 文档中,然后格式全乱了。反之,从 Word 文档中复制一段文字到网上,格式也全乱了,又需要重新调整。 排版太费时间:工具通常是这样,提供的功能越多,我们想的也越多,遇到的问题也就会越多。写作时总想着换种字体会不会好看一些,换个颜色试试,行高要不要调整一下,行距是不是太大了,用一下这个功能怎么样等等,时间就是这样一点点被浪费的。罗振宇在 2016 年 “时间的朋友”跨年演讲中提到过一个观点我非常认同,他说:”当我需要一个服务的时候,不要给我太多选择,请直接告诉我什么是最好的,我要你的最佳方案”。 难以团队协作:如果一个项目需要多人共同参与,比如共同翻译一本书,你可能需要版本管理、相互 Review、开放试读、开源、自出版等等,这些使用 Word 是无法满足需求的。也许你说可以使用 Google Doc,但前提是没那么多人会科学上网。

Markdown 如何解决这些问题的呢?

什么时候不合适用 Markdown 呢?

需要复杂排版的时候,比如纸版图书编辑就不太适合用 Markdown。我的做法是从 Markdown 导出 Word 文档,然后交给编辑。 需要复杂表格的时候,因为 Markdown 对表格的支持太简单了。 需要调整图片大小或直接贴本地图片的时候。 Markdown 怎么用? 先熟悉 Markdown 语法,再学会使用 Markdown 工具。请记住,语法是一切的基础,熟悉了语法以后,使用什么工具都可以,好用的工具只是让效率更高而已。

Markdown 语法分为:标准语法和扩展语法。

标准语法适用于所有 Markdown 工具,扩展语法可能每个工具都不一样。

为什么会有扩展语法呢?

由于 Markdown 本身的功能有限,一些特定的需求和场景无法被满足,因此产生了许多第三方的扩展语法。根据不同的需求和场景, Markdown 被扩展了很多功能,比如待办事项(任务列表)、代码高亮。

比较流行的扩展语法是 Github 风格的 Markdown:GitHub Flavored Markdown,毕竟全球最大的程序员『交友』网站。

正是由于 Markdown 第三方扩展语法太多,存在一定程序的碎片化,因此有一些机构和公司试图对 Markdown 语法进行标准化,这个可以参考 CommonMark 。

Markdown 语法

第二部分 RMarkdown