1162 字
6 分钟
Expressive Code 示例

在这里,我们将探索使用 Expressive Code 展示代码块的效果。提供的示例基于官方文档,您可以参考官方文档获取更多详细信息。

Expressive Code#

语法高亮#

语法高亮

常规语法高亮#

console.log('这段代码有语法高亮!')

渲染 ANSI 转义序列#

Terminal window
ANSI 颜色:
- 常规: 红色 绿色 黄色 蓝色 品红 青色
- 粗体: 红色 绿色 黄色 蓝色 品红 青色
- 暗淡: 红色 绿色 黄色 蓝色 品红 青色
256 色 (显示颜色 160-177):
160 161 162 163 164 165
166 167 168 169 170 171
172 173 174 175 176 177
完整 RGB 颜色:
森林绿 - RGB(34, 139, 34)
文本格式: 粗体 暗淡 斜体 下划线

编辑器和终端框架#

编辑器和终端框架

代码编辑器框架#

my-test-file.js
console.log('标题属性示例')

src/content/index.html
<div>文件名注释示例</div>

终端框架#

Terminal window
echo "这个终端框架没有标题"

PowerShell 终端示例
Write-Output "这个有标题!"

覆盖框架类型#

echo "看,妈妈,没有框架!"

PowerShell Profile.ps1
# 如果不覆盖,这将是一个终端框架
function Watch-Tail { Get-Content -Tail 20 -Wait $args }
New-Alias tail Watch-Tail

文本和行标记#

文本和行标记

标记整行和行范围#

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

选择行标记类型 (mark, ins, del)#

line-markers.js
function demo() {
console.log('这行被标记为已删除')
// 这行和下一行被标记为已插入
console.log('这是第二行已插入的内容')
return '这行使用默认的中性标记类型'
}

为行标记添加标签#

labeled-line-markers.jsx
<button
role="button"
{...props}
value={value}
className={buttonClassName}
disabled={disabled}
active={active}
>
{children &&
!active &&
(typeof children === 'string' ? <span>{children}</span> : children)}
</button>

在单独的行上添加长标签#

labeled-line-markers.jsx
<button
role="button"
{...props}
value={value}
className={buttonClassName}
disabled={disabled}
active={active}
>
{children &&
!active &&
(typeof children === 'string' ? <span>{children}</span> : children)}
</button>

使用类似 diff 的语法#

这行将被标记为已插入
这行将被标记为已删除
这是常规行

--- a/README.md
+++ b/README.md
@@ -1,3 +1,4 @@
+这是一个实际的 diff 文件
-all contents will remain unmodified
no whitespace will be removed either

结合语法高亮和类似 diff 的语法#

function thisIsJavaScript() {
// 整个代码块将被高亮显示为 JavaScript,
// 我们仍然可以向其添加 diff 标记!
console.log('要删除的旧代码')
console.log('新的闪亮代码!')
}

标记行内的单个文本#

function demo() {
// 标记行内的任何给定文本
return '支持多次匹配给定文本';
}

正则表达式#

console.log('yesyep 这两个词将被标记。')

转义正斜杠#

Terminal window
echo "Test" > /home/test.txt

选择行内标记类型 (mark, ins, del)#

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

自动换行#

自动换行

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

// 启用自动换行的示例
function getLongString() {
return '这是一个非常长的字符串,除非容器非常宽,否则很可能无法适应可用空间'
}

// 禁用自动换行的示例
function getLongString() {
return '这是一个非常长的字符串,除非容器非常宽,否则很可能无法适应可用空间'
}

配置换行的缩进#

// 启用 preserveIndent 的示例(默认启用)
function getLongString() {
return '这是一个非常长的字符串,除非容器非常宽,否则很可能无法适应可用空间'
}

// 禁用 preserveIndent 的示例
function getLongString() {
return '这是一个非常长的字符串,除非容器非常宽,否则很可能无法适应可用空间'
}

可折叠部分#

可折叠部分

5 collapsed lines
// 所有这些样板设置代码将被折叠
import { someBoilerplateEngine } from '@example/some-boilerplate'
import { evenMoreBoilerplate } from '@example/even-more-boilerplate'
const engine = someBoilerplateEngine(evenMoreBoilerplate())
// 这部分代码默认可见
engine.doSomething(1, 2, 3, calcFn)
function calcFn() {
// 可以有多个折叠部分
3 collapsed lines
const a = 1
const b = 2
const c = a + b
// 这部分将保持可见
console.log(`计算结果: ${a} + ${b} = ${c}`)
return c
}
4 collapsed lines
// 直到代码块结束的所有代码将再次被折叠
engine.closeConnection()
engine.freeMemory()
engine.shutdown({ reason: 'End of example boilerplate code' })

行号#

行号

为每个代码块显示行号#

// 这个代码块将显示行号
console.log('来自第 2 行的问候!')
console.log('我在第 3 行')

// 此代码块禁用行号
console.log('你好?')
console.log('对不起,你知道我在哪一行吗?')

更改起始行号#

console.log('来自第 5 行的问候!')
console.log('我在第 6 行')
Expressive Code 示例
https://fuwari.vercel.app/posts/expressive-code/
作者
粽子不解绳
发布于
2024-04-10
许可协议
CC BY-NC-SA 4.0