Expressive Code 示例

1074 字

5 分钟

Expressive Code 示例

2024-04-10

示例

Markdown

/

博客

/

演示

这里我们将探索如何使用 Expressive Code 展示代码块。以下示例基于官方文档，详情可参考官方说明。

Expressive Code#

语法高亮#

语法高亮

常规语法高亮#

1
console.log('这段代码已高亮显示！')

渲染 ANSI 转义序列#

1
ANSI 颜色：
2
- 普通：红 绿 黄 蓝 洋红 青
3
- 加粗： 红 绿 黄 蓝 洋红 青
4
- 变暗： 红 绿 黄 蓝 洋红 青
5

6
256 色（显示 160-177）：
7
160 161 162 163 164 165
8
166 167 168 169 170 171
9
172 173 174 175 176 177
10

11
全 RGB 颜色：
12
森林绿 - RGB(34, 139, 34)
13

14
文本格式：加粗 变暗 斜体 下划线

编辑器与终端框#

编辑器与终端框

代码编辑器框#

1
console.log('Title 属性示例')

1
<div>文件名注释示例</div>

终端框#

1
echo "这个终端框没有标题"

1
Write-Output "这个终端有标题！"

覆盖框类型#

1
echo "看！没有框！"

1
# 默认会是终端框，这里覆盖为代码框
2
function Watch-Tail { Get-Content -Tail 20 -Wait $args }
3
New-Alias tail Watch-Tail

文本与行标记#

文本与行标记

标记整行与行范围#

1
// 第 1 行 - 按行号标记
2
// 第 2 行
3
// 第 3 行
4
// 第 4 行 - 按行号标记
5
// 第 5 行
6
// 第 6 行
7
// 第 7 行 - 按范围 "7-8" 标记
8
// 第 8 行 - 按范围 "7-8" 标记

选择行标记类型（mark, ins, del）#

1
function demo() {
2
  console.log('这一行被标记为删除')
3
  // 这一行和下一行被标记为插入
4
  console.log('这是第二个插入的行')
5

6
  return '这一行使用默认的中性标记类型'
7
}

为行标记添加标签#

1
<button
2
  role="button"
3
  {...props}
4
  value={value}
5
  className={buttonClassName}
6
  disabled={disabled}
7
  active={active}
8
>
9
  {children &&
10
    !active &&
11
    (typeof children === 'string' ? <span>{children}</span> : children)}
12
</button>

在独立行添加长标签#

1
<button
2
  role="button"
3
  {...props}
4

5
  value={value}
6
  className={buttonClassName}
7

8
  disabled={disabled}
9
  active={active}
10
>
11

12
  {children &&
13
    !active &&
14
    (typeof children === 'string' ? <span>{children}</span> : children)}
15
</button>

使用 diff 风格语法#

1
这一行将被标记为插入
2
这一行将被标记为删除
3
这是一行普通内容

1
--- a/README.md
2
+++ b/README.md
3
@@ -1,3 +1,4 @@
4
+这是真实的 diff 文件
5
-所有内容都不会被修改
6
 没有空白会被移除

结合语法高亮与 diff 风格语法#

1
function thisIsJavaScript() {
2
  // 整个代码块会以 JavaScript 高亮，
3
  // 同时可以添加 diff 标记！
4
  console.log('旧代码将被移除')
5
  console.log('新代码上线！')
6
}

标记行内指定文本#

1
function demo() {
2
  // 标记行内任意指定文本
3
  return '支持多次匹配指定文本';
4
}

正则表达式#

1
console.log('yes 和 yep 都会被标记。')

转义斜杠#

1
echo "Test" > /home/test.txt

选择行内标记类型（mark, ins, del）#

1
function demo() {
2
  console.log('这些是插入和删除标记类型');
3
  // return 语句使用默认标记类型
4
  return true;
5
}

自动换行#

自动换行

每个代码块配置自动换行#

1
// 自动换行示例
2
function getLongString() {
3
  return '这是一个很长的字符串，除非容器非常宽，否则很可能无法完全显示'
4
}

1
// wrap=false 示例
2
function getLongString() {
3
  return '这是一个很长的字符串，除非容器非常宽，否则很可能无法完全显示'
4
}

配置换行缩进#

1
// preserveIndent 示例（默认启用）
2
function getLongString() {
3
  return '这是一个很长的字符串，除非容器非常宽，否则很可能无法完全显示'
4
}

1
// preserveIndent=false 示例
2
function getLongString() {
3
  return '这是一个很长的字符串，除非容器非常宽，否则很可能无法完全显示'
4
}

可折叠区块#

可折叠区块


5 collapsed lines
1
// 这些样板代码会被折叠
2
import { someBoilerplateEngine } from '@example/some-boilerplate'
3
import { evenMoreBoilerplate } from '@example/even-more-boilerplate'
4

5
const engine = someBoilerplateEngine(evenMoreBoilerplate())
6

7
// 这部分代码默认可见
8
engine.doSomething(1, 2, 3, calcFn)
9

10
function calcFn() {
11
  // 可以有多个折叠区块
3 collapsed lines
12
  const a = 1
13
  const b = 2
14
  const c = a + b
15

16
  // 这部分会保持可见
17
  console.log(`计算结果: ${a} + ${b} = ${c}`)
18
  return c
19
}
20

4 collapsed lines
21
// 这些代码会再次被折叠
22
engine.closeConnection()
23
engine.freeMemory()
24
engine.shutdown({ reason: '示例样板代码结束' })

行号显示#

行号显示

每个代码块显示行号#

1
// 此代码块会显示行号
2
console.log('来自第 2 行的问候！')
3
console.log('我在第 3 行')

// 此代码块不显示行号
console.log('你好？')
console.log('你知道我在第几行吗？')

更改起始行号#

5
console.log('来自第 5 行的问候！')
6
console.log('我在第 6 行')

Expressive Code 示例

https://blog.170529.xyz/posts/expressive-code/

作者

Starfallen

发布于

2024-04-10

许可协议

CC BY-NC-SA 4.0

Markdown Extended Features

Simple Guides for Fuwari