16 markdown
jiangming1399 edited this page 4 years ago

Markdown 语法规则

为什么要用 Markdown?

  • Markdown 是这个系统中 Wiki 和工单系统都在使用的语法
  • Markdown 文件可以在仓库页中被实时预览
  • Markdown 文件不需要任何特殊软件就能被打开
  • Markdown 简单易懂,一学就会
  • Markdown 可以让你专注于写作内容,而不是字体颜色什么的格式问题

推荐的Markdown编辑器

用记事本就可以编辑markdown文件(.md 文件)。

如果你不想记这些繁琐~~(其实一点也不繁琐)~~的代码,你可以使用小书匠Markdown编辑器

原生的 Markdown 语法

标题

一种样式的标题

  一级标题
  ===========
  上面的等于号个数你看着办就行
  
  二级标题
  -------------
  上面的减号个数你看着办就行

或者是另外一种标题方式

  # 一级标题
  ## 二级标题
  ### 三级标题
  #### 四级标题
  ##### 五级标题

使用4个及以上的减号,可以创建一个分割线(hr)

换行

Markdown中,换行可能有点奇怪。如果你在两段文字之间有一个以上的空行,它才会自动换行。如果你不想这么做,你可以手工在每段后面加上两个空格,这样就可以换行了。

例子:

今天天气很好呢

是啊 很不错 我们去吃西瓜吧
好哇


今天天气很好呢

是啊 
很不错  我们去吃西瓜吧  
好哇

列表

如果要创建一个无序列表,行首加一个 - 或者一个 *,后面跟着一个空格;
如果要创建一个有序列表,行首加一个 1. ,后面跟着一个空格。

  • 这是一个列表
  • 第二项
    • 也许还有第二层
  • 另外一项

  1. 一样的列表,不过是有序的
  2. 第二项
  3. 更深的一层
  4. 就是这样
  * 这是一个列表
  * 第二项
    * 也许还有第二层
  * 另外一项

  1. 一样的列表,不过是有序的
  2. 第二项
    3. 更深的一层
  4. 就是这样

引用

如果你需要引用一小段别处的句子,那么就要用引用的格式。

例如这样

只需要在文本前加入 > 这种尖括号(大于号)即可

强调

用一个*包围的是斜体,用两个*包围的是加粗,两个~包围的是删除线

** 东方Project **
是由上海的上海Alice幻乐团 出品的一系列游戏的总称。

** 东方Project ** 是由~~上海的~~*上海Alice幻乐团*出品的一系列游戏的总称。

图片与链接

插入链接与插入图片的语法很像,区别在图片前面多了一个感叹号( ! )

图片为:![文字描述](图片链接)

链接为:[文字描述](链接)

例子:CNM,你不会百度吗?
pic1.jpg
CNM,你不会[百度](https://www.baidu.com)吗?![pic1.jpg](https://img.acg.moe/common/0/07/%E4%BD%A0%E4%B8%8D%E4%BC%9A%E7%99%BE%E5%BA%A6%E5%90%97.jpg)

如果你要链接到本Wiki上的其他页面,那么地址是(wiki/page-name)。

例子:
这里是我们的服务条款
这里是我们的[服务条款](wiki/TOS)

如果你想上传图片到wiki,那么你需要把图片上传到仓库里面。 仓库里面的图片路径是:raw/master/path-to/file

例子:

现在我在仓库里面创建了一个文件夹img,里面有个名为gdut.png的图片。
gdut.png
![gdut.png](raw/master/img/gdut.png)

代码块

如果你想放一段程序,或者是一段预格式化的文字,你可以使用`来包围它(们)。

例子 我们大科二

cout << "我们大科二" << endl;

`我们大科二`
```
cout « “我们大科二” « endl;
```

特殊的 markdown 语法

公式

熟悉LaTeX公式的同学们可能会对这个语法感到很熟悉,因为这就是LaTeX公式语法!

LaTeX中,公式是用$$或者是\[或者是\(包围的,在这里也一样。不过不一样的是,Markdown会对某些特殊符号进行转义,所以我们需要进行修正。

Markdown中,反斜杠(\)被用作特殊字符。如果你想输入反斜杠,那你需要输入\\
Markdown中,LaTeX 的下标(下划线,_)是一个格式控制字符。如果你想输入它的话,那你需要输入\_

公式分为行内公式行间公式。以\(包围的是行内公式,以$$或者是\[包围的是行间公式。他们有什么不同呢?让我们来看一个例子:

例子

若已知的反应活化能\(E_a\),则在温度\(T_1\)时:$$\ln k_1=-\frac{E_a}{RT_1}+\ln A$$
若已知的反应活化能\\(E_a\\),则在温度\\(T_1\\)时:$$\ln k_1=-\frac{E_a}{RT_1}+\ln A$$

可以到这里了解更多LaTeX公式语法规则,也可以直接使用公式编辑器来生成,还可以手写识别

更详细的Markdown语法

http://www.appinn.com/markdown/