跳转至

Coder 程序员语法

预计阅读时长 : 3 分钟

Code

在技术类文档中，代码块是必不可少的部分。Markdown 中的代码块语法非常简单，只需要在代码块前后各加上三个反引号 ``` 即可。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
def getkey(user_file):
    '''清理非标准化的微博地址，提取用户的 UID 或者个性化域名'''
    url_key_list = []
    listnum = 0
    with open(user_file, 'r') as url_list:
        for url in url_list:
            listnum += 1
            try:
                keyword = re.search(r'\/(\d{10})|com\/(\w{4,32})|\/p\/\d{6}(\d{10})|^(\d{5,10})$', url).groups()
                url_key_list.append([key for key in keyword if key is not None][0])
            except AttributeError:
                print('第 %d 行格式有误：' % listnum, url)
        if listnum != len(url_key_list):
            unuseful = listnum - len(url_key_list)
            print('\n注意：总计发现%d个错误格式，请修正后再执行' % unuseful)
            sys.exit()
    return url_key_list

除了大块成段的引用之外， 还可以在行内进行引用。

行内引用
1
在行内使用`引用`语法，可以起到比加粗更引人注意的强调效果。

在行内使用 引用 语法，可以起到比加粗更引人注意的强调效果。

Code blocks

MkDocs 的 Code blocks ⧉ 在基本语法的基础上，增加了大量的特性，可以支持标题、行号、高亮、复制、注释等多种功能。

Python
1
2
3
4
5
def bubble_sort(items):
    for i in range(len(items)):
        for j in range(len(items) - 1 - i): #(1)
            if items[j] > items[j + 1]:
                items[j], items[j + 1] = items[j + 1], items[j]
  1. 第二层循环和条件判断

Terminal

想在 Mkdocs 中展示终端命令，有两个插件可以实现类似的效果。

termynal ⧉ 主要用于展示纯文本样式的终端操作，可以在操作指南类的文档中使用。

show progressDone!

而 mkdocs-asciinema ⧉ 可以在 Markdown 文本中插入终端录制的虚拟视频，用于替代视频或者 GIF，展示更加复杂和丰富的效果。