Markdwon  分享

NKDACS-IT部/张万鹏

Markdown 简介

Markdown 是一个 Web 上使用的文本到 HTML 的转换工具,可以通过简单、易读易写的文本格式生成结构化的 HTML 文档。目前 github、Stackoverflow、 知乎等网站均支持这种格式。而在我们的常用工具中,如 Jupyter Notebook、R Studio 也均支持了 Markdown。如今 Markdown 的使用范围也远不止 Web 上 HTML 生成,它凭借着优秀的排版效果、使用体验和跨平台支持,在学术界也开始备受青睐。

段落和换行

一个 Markdown 段落是由一个或多个连续的文本行组成,它的前后要有一个以上的空行(空行的定义是显示上看起来像是空的,便会被视为空行。比方说,若某一行只包含空格和制表符,则该行也会被视为空行)。普通段落不该用空格或制表符来缩进。

标题

在行首插入1到6个 #,对应标题的1到6阶,例如:


# 这是 H1

## 这是 H2

###### 这是 H6

区块引用

Markdown 通过 > 符号来进行区块引用


> 这是一次
> 关于 Markdown 的分享
>
> 来自 NKDACS

这是一次 关于 Markdown 的分享

来自 NKDACS

无序列表


* 南开大学
* 统计与数据科学学院
* NKDACS

注:*号可替换为+/-

  • 南开大学
  • 统计与数据科学学院
  • NKDACS

有序列表


1. 南开大学
2. 统计与数据科学学院
3. NKDACS
  1. 南开大学
  2. 统计与数据科学学院
  3. NKDACS

段落列表

列表项目可以包含多个段落,每个项目下的段落都必须缩进 4 个空格或是 1 个制表符


1.  这是第一项的第一段内容哦!

    这是第一项的第二段内容哦!

2.  这是第二项的内容!
  1. 这是第一项的第一段内容哦!

    这是第一项的第二段内容哦!

  2. 这是第二项的内容!

代码

如果要标记一小段行内代码,你可以用反引号把它包起来(`),例如:

Example: cout<<"Hello, World!".
Example: `cout<<"Hello, World!"`.

Example: cout<<"Hello, World!".

Example: cout<<"Hello, World!".

代码区块

首末使用三个 ` 包围,能够把代码按代码块展现出来

```python

import torch
import numpy as np

np_data = np.arange(6).reshape((2, 3))
torch_data = torch.from_numpy(np_data)
tensor2array = torch_data.numpy()

```

import torch
import numpy as np

np_data = np.arange(6).reshape((2, 3))
torch_data = torch.from_numpy(np_data)
tensor2array = torch_data.numpy()

链接(行内式)

通过方括号、圆括号,能够让文字变成链接:


我们 NKDACS 的[官网](https://www.nkdacs.com)

我们 NKDACS 的官网

链接(参考式)


I get 10 times more traffic from [Google] [1] than from
[Yahoo] [2] or [MSN] [3].

  [1]: http://google.com/        "Google"
  [2]: http://search.yahoo.com/  "Yahoo Search"
  [3]: http://search.msn.com/    "MSN Search"

I get 10 times more traffic from Google than from Yahoo or MSN.

强调

Markdown 使用星号和底线作为标记强调字词的符号,被单个包围会被转成斜体,用两个围则被转成粗体


*single asterisks*
_single underscores_
**double asterisks**
__double underscores__

single asterisks

single underscores

double asterisks

double underscores

图片

插入图片的方式很简单,如下所示:


![图片的描述文字](http://www.nankai.edu.cn/_upload/tpl/00/3f/63/template63/images/logo.png)
图片的描述文字
图片的描述文字

转义

Markdown 有很多内置符号,我们有时候反而只是单纯地想打印出它们,这时只需在相应符号前加一个反斜杠即可


我想打一个反斜杠符号出来:\\

我想打一个反斜杠符号出来:\

NKDACS 网站上的一些特殊情况

  • Markdown 规则众多,在基本框架格式上,NKDACS.com 采用了较为通用且严格的规则,因此需要多加注意,至少满足前面所讲的基本要求是肯定没有问题的。

  • 与此同时,在细节之处,我们也补充加入了少量新特性,从而满足一些特殊的需求。

\(\LaTeX\)

  • 网站支持 \(\LaTeX\),因此各位请放心使用 \(\LaTeX\),并且基本上支持绝大多数语句!只需要在 Markdown 中正常使用$ $包围起来的 \(\LaTeX\) 语句即可。

  • 需要特别注意的是,我们只支持$ $$$ $$包围起来的 \(\LaTeX\) 语句,并不支持\( \)\[\]包围起来的语句。

注意:

  1. $符号内包围的公式开头和末尾不要有空格!
  2. $$ $$的前一行和后一行都需要是空行!

特殊格式

属于进阶用法,请在熟练掌握基本 Markdown 语法后,查看我们放在 nkdacs 网站上的说明页面:

https://www.nkdacs.com/tutorial/test/

谢谢