Markdown极简入门

Markdown极简入门

本文档写给计算机学院大学生科学技术协会内部新成员,在帮助完成科协工作的同时,希望大家可以爱上 Markdown。

一、 认识 Markdown

Markdown 是一种轻量级的标记语言,语法十分简单,是十分轻量的。正由于其作为一门语言,才得以使用 GitHub 进行管理及版本控制,科协现将部分重要内部文件使用 GitHub 进行版本控制,使用 Markdown 进行编写。当然 Markdown 的意义远不止于此,像是日常记笔记、写 blog 以及项目文档管理等等,使用 Markdown 都会事半功倍。口说无凭,带伙用起来就会被迷住的。

Markdown 编辑器

俗话说,工欲善其事必先利其器(突然很不像程序员的画风,不过总不能在记事本写,哈哈)。推荐的编辑器当然是 Typora ,极简的风格搭配适合自己的主题可以瞬间提升你对美的认知,主题的配置就不再赘述了,对程序员来讲当然不在话下。

Markdown 官方文档

这里提供几个包括官方 Markdown 语法规则在内的几个规范文档。当然,本文我也把基本的用法描述一下。

使用 Markdown 的优点

  • 专注你的文字内容,安心写作;
  • 兼容 HTML,极简的语言也可以玩的花里胡哨(不过太复杂就有悖语言哲学了);
  • 可被浏览器渲染;
  • 轻松的导出 HTML、PDF 和本身的 .md 文件;
  • 纯文本内容,兼容所有的文本编辑器与字处理软件(所以其实用啥写都行);
  • 随时修改你的文章版本,不会导致文件版本导致混乱;
  • 可支持公式及特殊符号的输入;
  • 直观、简单!简单!简单!

二、Markdown 语法的简要规则

标题

标题是每篇文章都需要也是最常用的格式,在 Markdown 中,如果一段文字被定义为标题,只要在这段文字前加 # 号即可。
注意在#后加一个空格。

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-DfCtxnV2-1589817471892)(images/01.png)]

列表

在 Markdown 下,列表的显示只需要在文字前加上 + ,-* 即可变为无序列表(科协的推荐统一用-),有序列表则直接在文字前加 1.2.3.。同样,符号要和文字之间加上一个字符的空格。

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-cieBXeH6-1589817471896)(images/02.png)]

引用

如果你需要引用一小段别处的句子,那么就要用引用的格式。
只需要在文本前加入 > 这种尖括号(大于号)即可。

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-VYVa37NM-1589817471897)(images/03.png)]

图片与链接

插入链接与插入图片的语法很像,区别在一个 !号。插入图片的地址需要图床,日常使用推荐 CloudApp 的服务,生成URL地址即可。

但在科协整理文件时在仓库根目录会设有一个image文件夹,下面依据各文档进行细分,图片统一放置于此。

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-INIPPXEZ-1589817471900)(images/04.png)]

粗体与斜体

Markdown 的粗体和斜体也非常简单,用两个 * 包含一段文本就是粗体的语法,用一个 * 包含一段文本就是斜体的语法。

例如:

**这里是粗体** -> 这里是粗体

*这里是斜体* -> 这里是斜体

表格

表格是 Markdown 比较累人的地方,但Typora很好地解决了这一问题,使表格变得超级简单。表格语法中----,:----,----:,:----:分别对应默认对齐,居左对齐,居右对齐以及居中对齐(Typora 有时会吞掉你的对齐格式,CSDN 也会)。

例子如下:

	| Tables        | Are           | Cool  |
	| ------------- |:-------------:| -----:|
	| col 3 is      | right-aligned | $1600 |
	| col 2 is      | centered      |   $12 |
	| zebra stripes | are neat      |    $1 |

这种语法生成的表格如下:

TablesAreCool
col 3 isright-aligned$1600
col 2 iscentered$12
zebra stripesare neat$1

代码块

作为程序猿,需要优雅的引用代码框。

Markdown 下只需要用 "```"(这是反引号,大部分这个键在键盘左上角,数字 1的前面,某些67键机械键盘除外)把中间的代码包裹起来。可在起始的 "```"后标注代码块对应语言,当然在Typora中键入 "```"后回车即可选择对应语言。图例:

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-Mtxtvwf0-1589817471903)(images/06.png)]

不过不同规范支持的代码种类不同(比如 CSDN 就不能渲染 MATLAB以及R语言等,问就是经历过,不过Typora可以支持很多很多语言)。

分割线

分割线的语法只需要另起一行,连续输入三个星号 *** 即可。


公式及特殊符号

科协内部文档应该用不到这一功能,而专业的数学排版会选择 LaTeX,所以日常使用中使用不到这一功能的可以忽略(上面一条分割线出现的好合适),但毕竟是 Markdown 一大特色,这里推荐一篇优秀博文

  • 3
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

SuanCaiyu1806

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值