Skip to content

可以支持的元素

本文档支持markdown拓展功能,可以使用诸如:数学公式、语法高亮,高亮标注等等原生markdown不支持的功能。有关更多拓展功能的详细描述可以参考模板网站,在这里我们只是列举了一些可能比较常用的元素以便参考。

代码

插入代码

可以方便的在网页中插入代码,并且可以指定不同语言的语法高亮,如以下代码可以插入Python语言的代码块。

1
2
3
4
``` python
import numpy as np
import torch.nn as nn
```
效果:
1
2
import numpy as np
import torch.nn as nn

代码特定行高亮

有时候为了更加直观的进行展示,你可以指定代码块中进行高亮的行,如下所示。

1
2
3
4
5
6
7
8
``` python hl_lines="3 4"
""" Bubble sort """
def bubble_sort(items):
    for i in range(len(items)):
        for j in range(len(items) - 1 - i):
            if items[j] > items[j + 1]:
                items[j], items[j + 1] = items[j + 1], items[j]
```
效果:
1
2
3
4
5
6
""" Bubble sort """
def bubble_sort(items):
    for i in range(len(items)):
        for j in range(len(items) - 1 - i):
            if items[j] > items[j + 1]:
                items[j], items[j + 1] = items[j + 1], items[j]
更多有关代码的使用细节可以参考CodeHilite

表格

1
2
3
4
5
dog | bird | cat
----|------|----
foo | foo  | foo
bar | bar  | bar
baz | baz  | baz
效果:

dog bird cat
foo foo foo
bar bar bar
baz baz baz

数学公式

文档支持使用Latex进行数学公式的编辑。

1
2
3
$$
\frac{n!}{k!(n-k)!} = \binom{n}{k}
$$
效果:

\frac{n!}{k!(n-k)!} = \binom{n}{k}

Admonition

为了更加突出的展示显著信息,你可以使用Admonition,我们规定了两种比较常用的形式;分别是“Why”:用来描述/解释实验/代码的现象、“Ref”:用来介绍你所引用的参考文献。它们的实现方式如下所示。

1
2
!!! info "Ref"
    [Massive Exploration of Neural Machine Translation Architectures](https://arxiv.org/abs/1703.03906), Denny Britz, Anna Goldie et al.
效果:

1
2
!!! question "Why"
    From the authors: "*This way, [...] that makes it easy for SGD to “establish communication” between the input and the output. We found this simple data transformation to greatly improve the performance of the LSTM.*"
效果:

Why

From the authors: "This way, [...] that makes it easy for SGD to “establish communication” between the input and the output. We found this simple data transformation to greatly improve the performance of the LSTM."

更多有关Admonition的使用细节可以参考Admonition