Effieapp 中文文档 下载 App

代码块——写技术文档时的格式保护

怎么创建代码块

在 Effie 里,标准 Markdown 的三反引号围栏就会自动渲染成代码块:

def hello():
    print("Hello, Effie")

Effie 会自动把代码块里的内容用等宽字体显示,和正文明显区分开。

指定语言

在反引号后面加上编程语言名称,Effie 会尝试启用对应语言的语法高亮(支持情况以官方最新版为准):

const message = "Effie";
console.log(message);

代码块 vs 行内代码

用法语法效果
行内代码code在正文里用等宽字体显示一小段代码或命令
代码块\\\` 包裹独立段落、等宽字体、保留缩进和换行

行内代码适合标记一个函数名、命令行参数或文件名,代码块适合展示完整的函数、配置片段等。

Effie 代码块的特点

常见用法