Skip to content

Markdown

使用 Markdown 语法来编写文档,是一个程序员以及一个科研工作者的必备技能,尽管在一些方面上来说,Markdown 与程序员的关系更为密切,但是科研工作者同样需要一种便携的笔记工具,以及在公布代码的时候需要撰写对应的 Readme,因此,这一技能是必须的。

Markdown 语法非常简单,只需要掌握一些基本的语法即可,下面是一些常用的语法:

  • 标题:使用 # 号来表示标题,例如:# 一级标题## 二级标题### 三级标题,以此类推。
  • 段落:段落之间使用一个空行来分隔。
  • 强调:使用 *_ 号来表示强调,例如:*斜体*_斜体_**粗体**__粗体__
  • 列表:使用 *+- 号来表示无序列表,使用数字加 . 号来表示有序列表。
  • 链接:使用 [链接文本](链接地址) 来表示链接,例如:[百度](https://www.baidu.com)
  • 代码块:使用三个连续反引号 ``` 来表示代码块,而单个反引号则可以表示行内代码。其中在代码块中,反引号后面跟上语言通常可以生成对应的代码高亮。
  • 图片:使用 ![图片描述](图片地址) 来表示图片,例如:![图片描述](图片地址)

Markdown 语言具有若干开箱即用的编辑器,其中推荐的包括 Obsidian, Typora, VSCode 等。

更加详细的 Markdown 教程见:Markdown 官方教程

Released under the MIT License.