代码块——写技术文档时的格式保护
怎么创建代码块
在 Effie 里,标准 Markdown 的三反引号围栏就会自动渲染成代码块:
def hello():
print("Hello, Effie")
Effie 会自动把代码块里的内容用等宽字体显示,和正文明显区分开。
指定语言
在反引号后面加上编程语言名称,Effie 会尝试启用对应语言的语法高亮(支持情况以官方最新版为准):
const message = "Effie";
console.log(message);
代码块 vs 行内代码
| 用法 | 语法 | 效果 |
|---|---|---|
| 行内代码 | code | 在正文里用等宽字体显示一小段代码或命令 |
| 代码块 | \\\` 包裹 | 独立段落、等宽字体、保留缩进和换行 |
行内代码适合标记一个函数名、命令行参数或文件名,代码块适合展示完整的函数、配置片段等。
Effie 代码块的特点
- 不支持复制按钮 / 行号显示等编辑器功能 — 纯展示
- 导出 PDF / Word / 长图时会保留代码块格式
- 导出 Markdown 时直接保留围栏语法
- 如果需要写大量代码还是用专业编辑器更好
常见用法
- 技术文档里展示命令行参数
- 论文里引用数学公式时也可以用代码块保持格式
- 产品文档里展示 JSON / XML 配置片段