2109 字
11 分钟
Fuwari 博客改造计划:如何使用 Expressive Code
在这篇文章中,我们将探索如何使用 Expressive Code 来增强 Markdown 中的代码块显示。以下示例基于官方文档,您可以查阅文档以获取更多详细信息。
1. 语法高亮 (Syntax Highlighting)
Expressive Code 提供了强大的语法高亮功能。
常规语法高亮
console.log('这段代码具有语法高亮!')渲染 ANSI 转义序列
ANSI 颜色示例:- 标准: 红色 绿色 黄色 蓝色 洋红 青色- 加粗: 红色 绿色 黄色 蓝色 洋红 青色- 变暗: 红色 绿色 黄色 蓝色 洋红 青色
256 色 (显示 160-177):160 161 162 163 164 165166 167 168 169 170 171172 173 174 175 176 177
全 RGB 颜色:森林绿 - RGB(34, 139, 34)
文本格式: 加粗 变暗 斜体 下划线2. 编辑器与终端外框 (Editor & Terminal Frames)
代码编辑器外框
```js title="my-test-file.js"console.log('带有标题属性的示例')```console.log('带有标题属性的示例')```html <!-- src/content/index.html --><div>通过注释指定文件名的示例</div>```<div>通过注释指定文件名的示例</div>终端外框
```bashecho "这个终端外框没有标题"```echo "这个终端外框没有标题"```powershell title="PowerShell 终端示例"Write-Output "这个带有一个标题!"```Write-Output "这个带有一个标题!"覆盖外框类型
```sh frame="none"echo "看,没有任何外框!"```echo "看,没有任何外框!"```ps frame="code" title="PowerShell Profile.ps1"# 如果不手动覆盖,这通常会被自动识别为终端外框function Watch-Tail { Get-Content -Tail 20 -Wait $args }New-Alias tail Watch-Tail```# 如果不手动覆盖,这通常会被自动识别为终端外框function Watch-Tail { Get-Content -Tail 20 -Wait $args }New-Alias tail Watch-Tail3. 文本与行标记 (Text & Line Markers)
标记整行或行范围
```js {1, 4, 7-8}// 第 1 行 - 通过行号标记// 第 2 行// 第 3 行// 第 4 行 - 通过行号标记// 第 5 行// 第 6 行// 第 7 行 - 通过范围 "7-8" 标记// 第 8 行 - 通过范围 "7-8" 标记```// 第 1 行 - 通过行号标记// 第 2 行// 第 3 行// 第 4 行 - 通过行号标记// 第 5 行// 第 6 行// 第 7 行 - 通过范围 "7-8" 标记// 第 8 行 - 通过范围 "7-8" 标记选择行标记类型 (mark, ins, del)
```js title="line-markers.js" del={2} ins={3-4} {6}function demo() { console.log('这一行被标记为已删除') // 这一行和下一行被标记为已插入 console.log('这是第二个插入行')
return '这一行使用中性的默认标记类型'}```function demo() { console.log('这一行被标记为已删除') // 这一行和下一行被标记为已插入 console.log('这是第二个插入行')
return '这一行使用中性的默认标记类型'}为行标记添加标签
```jsx {"1":5} del={"2":7-8} ins={"3":10-12}<button role="button" {...props} value={value} className={buttonClassName} disabled={disabled} active={active}> {children && !active && (typeof children === 'string' ? <span>{children}</span> : children)}</button>```<button role="button" {...props} value={value} className={buttonClassName} disabled={disabled} active={active}> {children && !active && (typeof children === 'string' ? <span>{children}</span> : children)}</button>添加长标签
```jsx {"1. 在这里提供 value 属性:":5-6} del={"2. 移除 disabled 和 active 状态:":8-10} ins={"3. 添加此项以在按钮内渲染子元素:":12-15}<button role="button" {...props}
value={value} className={buttonClassName}
disabled={disabled} active={active}>
{children && !active && (typeof children === 'string' ? <span>{children}</span> : children)}</button>```<button role="button" {...props}
value={value} className={buttonClassName}
disabled={disabled} active={active}>
{children && !active && (typeof children === 'string' ? <span>{children}</span> : children)}</button>使用类似 Diff 的语法
```diff+这一行将被标记为已插入-这一行将被标记为已删除这是一行普通代码```这一行将被标记为已插入这一行将被标记为已删除这是一行普通代码```diff--- a/README.md+++ b/README.md@@ -1,3 +1,4 @@+这是一个真实的 diff 文件示例-所有内容都将保持原样 连空格也不会被移除```--- a/README.md+++ b/README.md@@ -1,3 +1,4 @@+这是一个真实的 diff 文件示例-所有内容都将保持原样 连空格也不会被移除将语法高亮与 Diff 语法结合
```diff lang="js" function thisIsJavaScript() { // 整个代码块按 JavaScript 高亮, // 同时我们仍然可以添加 diff 标记!- console.log('旧的代码将被移除')+ console.log('全新的闪亮代码!') }```function thisIsJavaScript() { // 整个代码块按 JavaScript 高亮, // 同时我们仍然可以添加 diff 标记! console.log('旧的代码将被移除') console.log('全新的闪亮代码!')}标记行内的特定文本
```js "指定文本"function demo() { // 标记行内任何出现的“指定文本” return '支持多次匹配指定文本';}```function demo() { // 标记行内任何出现的“指定文本” return '支持多次匹配指定文本';}正则表达式
```ts /ye[sp]/console.log('单词 yes 和 yep 都将被标记。')```console.log('单词 yes 和 yep 都将被标记。')标记行内标记类型 (mark, ins, del)
```js "return true;" ins="inserted" del="deleted"function demo() { console.log('这些是 inserted 和 deleted 标记类型'); // return 语句使用默认标记类型 return true;}```function demo() { console.log('这些是 inserted 和 deleted 标记类型'); // return 语句使用默认标记类型 return true;}4. 自动换行 (Word Wrap)
为单个代码块配置换行
```js wrap// 开启换行的示例function getLongString() { return '这是一段非常长的字符串,如果不开启自动换行,它很可能超出现在容器的显示范围,除非容器极宽。'}```// 开启换行的示例function getLongString() { return '这是一段非常长的字符串,如果不开启自动换行,它很可能超出现在容器的显示范围,除非容器极宽。'}```js wrap=false// 关闭换行的示例 (wrap=false)function getLongString() { return '这是一段非常长的字符串,如果不开启自动换行,它很可能超出现在容器的显示范围,除非容器极宽。'}```// 关闭换行的示例 (wrap=false)function getLongString() { return '这是一段非常长的字符串,如果不开启自动换行,它很可能超出现在容器的显示范围,除非容器极宽。'}配置换行后的缩进
```js wrap preserveIndent// 保持缩进示例 (默认开启)function getLongString() { return '长字符串换行后会保持与上一行相同的缩进位置。'}```// 保持缩进示例 (默认开启)function getLongString() { return '长字符串换行后会保持与上一行相同的缩进位置。'}```js wrap preserveIndent=false// 关闭保持缩进示例 (preserveIndent=false)function getLongString() { return '长字符串换行后将不再保持缩进,而是从行首开始。'}```// 关闭保持缩进示例 (preserveIndent=false)function getLongString() { return '长字符串换行后将不再保持缩进,而是从行首开始。'}5. 可折叠代码段 (Collapsible Sections)
```js collapse={1-5, 12-14, 21-24}// 这里的初始化样板代码将被折叠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() { // 您可以设置多个折叠区域 const a = 1 const b = 2 const c = a + b
// 这一行保持可见 console.log(`计算结果: ${a} + ${b} = ${c}`) return c}
// 结尾的样板代码也会被再次折叠engine.closeConnection()engine.freeMemory()engine.shutdown({ reason: 'End of example boilerplate code' })```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' })6. 行号 (Line Numbers)
为代码块显示行号
```js showLineNumbers// 这个代码块将显示行号console.log('来自第 2 行的问候!')console.log('我在第 3 行')```// 这个代码块将显示行号console.log('来自第 2 行的问候!')console.log('我在第 3 行')```js showLineNumbers=false// 这个代码块禁用了行号console.log('你好?')console.log('抱歉,你知道我在哪一行吗?')```// 这个代码块禁用了行号console.log('你好?')console.log('抱歉,你知道我在哪一行吗?')修改起始行号
```js showLineNumbers startLineNumber=5console.log('来自第 5 行的问候!')console.log('我在第 6 行')```console.log('来自第 5 行的问候!')console.log('我在第 6 行') Fuwari 博客改造计划:如何使用 Expressive Code
https://fuwari.vercel.app/posts/fuwari博客改造计划如何使用expressive-code/