二甲基

引入完整文件#

在文章中使用注释指令：

路径相对于当前文章的 index.md 所在目录书写。本站的示例片段位于 content/snippets/include-example.md，因此从 posts/markdown-include/ 出发需要向上两级。

渲染效果：

按行号切片引入#

只引入目标文件中指定范围的行：

1
<!-- @include: ../../snippets/include-example.md{5-9} -->

渲染效果：

行号从文件第一行开始计数（含首尾）。需要注意的是：行号会随片段文件被编辑而漂移，共享片段更推荐使用下面的命名区块方式。

按命名区块（Region）引入#

在源码中使用 #region 和 #endregion 标记公共区块：

1
// #region auth-config
2
export const authConfig = {
3
  enabled: true,
4
  provider: 'github',
5
};
6
// #endregion

在 Markdown 中精准导入该区块：

1
<!-- @include: ../../snippets/include-example.md#public-api -->

渲染效果：

目标片段中的 #region public-api 与 #endregion public-api 之间的内容被精确提取，区块外的一行说明文字不会出现。

三种方式对照#

典型用法#

• 公共前置条件：把「环境依赖」段落放进 snippets/prerequisites.md，所有教程文章统一导入。
• 配置片段：真实源码文件里标记 #region，文档直接引用，保证文档与代码永不脱节。
• 多语言文章：中英文文章共享同一段代码示例，避免两处维护。

构建特性#

• 所有的片段嵌入均在构建编译期完成，输出标准的静态 AST 节点。
• 零运行时开销，代码高亮与行号完全同步生效。