使用 Markdown 写作那些事儿

时间:2022-08-03 06:42:55

最近喜欢用“那些事儿”来命名标题,可能是明朝那些事儿看多了吧,哈哈啊,今天说说如何使用 Markdown 语言。

同步发布在我的简书 使用 Markdown 写作那些事儿

说开始

说起 Markdown,最开始是在 Github 上使用,使用来做说明文档用的,也就是 README.md 文件,于是就接触起来,起初还不明白为什么是.md结尾的,后来使用多了也就了解了,遇到不知道怎么用的语法,查一查也就慢慢记录下来,说起记录,我自己平时印象笔记或者getpocket来记录碎片化的搜索,可能那会需要搜索一个知识点,发现正片文章很好,要么全复制下来保存在印象笔记中,要么加入到getpocket中,它会帮我储存,都很好用,说起记录就说跑题了,关于记录这件事儿,以后单独说说哈。

使用 Markdown 写作那些事儿

Markdown

言归正传来说 Markdown,首先,Markdown 是一种轻量级的标记语言,类比 HTML,HTML可以被浏览器解析,那么Markdown 也有它相应的解析器,关于 Markdown 历史发展等等这里就不多赘述了,网上多的是,大家可自行搜索了解即可。

需要说一点,Markdown 的目标是实现“易读易写”,这也是这么多人喜欢用它的原因,同样也包括我自己,我可以写一份 Markdown 文件,就可以发布在不同的平台,也可以生成不同格式的文件用来传输,比如:PDF、HTML等等。它解决了痛点同时提高了工作效率,自然用的人就多了。

我这里就先分享下我平时使用的 Markdown 语法,后期有时间会丰富一下。

Markdown 语法

引用

使用” > ” 来标记引用

实例:

这是我引用的一段文字,可以发现背景是不一样的

标题

使用” # ” 来标记标题,这个使用的最多,基本上每一篇都需要用到,是非常常用的标记,根据”#”个数来调节标题的大小,

实例:

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

要养成标准的习惯,”#”号后面空一格在写文字。

链接

插入链接
我的Github

图片

插入图片
使用 Markdown 写作那些事儿

表格

直接以代码的形式贴出来了

库名称 | 库信息
------- | -------
[todo-mvp](https://github.com/googlesamples/android-  architecture/tree/todo-mvp/)  | Google googlesamples MVP
[RxJava](https://github.com/ReactiveX/RxJava) | 一个在 Java VM 上使用可观测的序列来组成异步的、基于事件的程序的库
[RxAndroid](https://github.com/ReactiveX/RxAndroid) | RxAndroid 是 RxJava 的一个针对 Android 平台的扩展

显示效果:

库名称 库信息
todo-mvp Google googlesamples MVP
RxJava 一个在 Java VM 上使用可观测的序列来组成异步的、基于事件的程序的库
RxAndroid RxAndroid 是 RxJava 的一个针对 Android 平台的扩展

是不是很简单,这个是我 SimpleNews.io 中README.md 中的表格,这里拿来做下说明,表格使用还是挺多的。就是如果嵌套较多的话看起来就不那么优雅了。适当使用即可。

粗体与斜体

用两个“*”是粗体,一个 “*” 是斜体(我这里为了显示用的大写的*,正常使用用英文状态下的)

实例:
哥们我是粗体
姐们我是斜体

我一半是用斜体来引用我参考的文档或者一些开源库

代码

简单地缩进 4 个空格或是 1 个制表符就可以也可以使用 ```中间代码```(同样注意我这是为了显示使用的中文下的`)

实例:

我是代码

我也是代码

邮箱

使用“”来标记
实例:xxxxxx@gmail.com

其他

换行:使用
标签
分割线:三个以上星号来


这里简单介绍了几个平时自己最常用的标记,另外也可以使用 HTML 标记语言来书写文档,同样会解析,别忘了浏览器会帮我们解析它的,编写过程中可能有不对或者遗漏的地方,欢迎拍砖指正!

参考