如何配置代码块

#如何配置代码块| 来源: 网络整理| 查看: 265

代码块的配置

下面讨论如何配置网站中的代码块(code blocks)。

参考：Code blocks - Material for MkDocs

配置方法

首先，为了实现PyMdown对代码块的优化配置，需要在 mkdocs.yml中的 markdown_extension部分加入新内容：

markdown_extensions: - pymdownx.highlight: #代码块代码高亮 anchor_linenums: true #对代码块显示行号 line_spans: __span pygments_lang_class: true #显示代码所属语言 - pymdownx.inlinehilite #文内代码的高亮显示 - pymdownx.snippets # 应该是用不到 - pymdownx.superfences # 应该是用不到，也没看懂用来干什么

另外，在 mkdocs.yml的 theme部分下的 features子项加入：

theme: features: - content.code.copy

可以使代码块支持复制。

使用样例 1. 代码块基本样例 ``` py import tensorflow as tf ```

实现为：

import tensorflow as tf 怎么实现把“代码块的代码”放进代码块格式的

这玩意和block的新方法是一个思路，把外层代码块写成四个小引号:

````markdown ``` py import tensorflow as tf ``` ````

显然你看到的这个代码块是由五个小引号构成的，这个小引号同样要求不少于三个

2. 代码块命名 ``` py title="bubble_sort.py" 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] ```

实现为:

bubble_sort.pydef 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]

前面说看不懂用来干什么的 superfences或者 snippets在此处起到了作用，所以还是加上吧。

3. 加入活动注释的代码

英文名为“code block with annotation”，即替代原有代码中的大块注释的项目：

theme: features: - content.code.annotate # (1) I'm a code annotation! I can contain code, formatted text, images, ... basically anything that can be written in Markdown.

其实现方法为：

``` yaml theme: features: - content.code.annotate # (1) ``` 1. I'm a code annotation! I can contain `code`, __formatted text__, images, ... basically anything that can be written in Markdown. 4. 显示代码块的行号

实现样例如：

1 2 3 4 5def 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]

其代码为：

``` py linenums="1" 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] ```

其中 linenums = ，中输入第一行的行号。

5. 代码块中高亮显示部分行

使用 hl_lines作为设置，但该参数默认从1开始数行号，无视 linenums对起始行号的规定。

``` py hl_lines="2 3" linenums="1" 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 5def 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] 其他个性化设置

该框架还可提供配色和活动注释的个性化设置

参见：Code blocks - Material for MkDocs的“Customization”部分。

【本文地址】

如何配置代码块

如何配置代码块

今日新闻

推荐新闻