如何用额外HTML包裹Rmarkdown子文档并自动填充标题

1. 简化子文档结构 #

把my_info_box.Rmd里的HTML代码全部删掉，只保留YAML标题和核心Markdown内容，示例如下：

---
title: "重要提示"
---
这是信息框的核心内容，支持标准Markdown语法，比如**高亮文本**、
- 列表项1
- 列表项2

2. 实现自动包裹HTML与标题注入 #

下面提供两种可行方案，任选其一即可：

方案一：用Pandoc Lua过滤器（推荐） #

这种方式更灵活，不依赖R代码，直接通过Pandoc处理文档结构。

1. 创建名为info_box_filter.lua的Lua脚本，内容如下：

function Div(el)
  -- 识别带有info-box类的子文档块
  if el.classes:includes("info-box") then
    -- 提取子文档的YAML标题，默认用"提示"当兜底
    local box_title = el.attributes.title or "提示"
    -- 自定义你的HTML结构（这里用示例结构，可按需修改）
    local html_prefix = '<div class="custom-info-box"><span class="box-icon">🔔</span><span class="box-title">' .. box_title .. '</span><div class="box-content">'
    local html_suffix = '</div></div>'
    -- 用HTML包裹子文档内容并返回
    return pandoc.RawBlock('html', html_prefix) .. el.content .. pandoc.RawBlock('html', html_suffix)
  end
end

2. 在主文档的YAML输出配置中引入这个过滤器：

output:
  rmarkdown::md_document:
    pandoc_args: ["--lua-filter", "info_box_filter.lua"]

3. 在主文档中引入子文档时，添加info-box类：

方案二：用Knitr钩子函数 #

通过R代码的钩子在渲染前后插入HTML结构。

在主文档的开头添加以下R代码块：

knitr::knit_hooks$set(child = function(before, options, envir) {
  if (before) {
    -- 读取子文档的YAML元数据，提取标题
    child_meta = rmarkdown::yaml_front_matter(options$child)
    box_title = child_meta$title %||% "提示"
    -- 输出HTML开头部分
    return glue::glue('<div class="custom-info-box"><span class="box-icon">🔔</span><span class="box-title">{box_title}</span><div class="box-content">')
  } else {
    -- 输出HTML结尾部分
    return '</div></div>'
  }
})

注：如果没装glue包，先运行install.packages("glue")安装。

之后在主文档中直接引入子文档即可，无需额外参数：

关键说明 #

• 两种方案中的HTML结构都可以根据你的需求自定义，比如替换图标、调整类名和样式；
• 若用Lua过滤器，确保你的Pandoc版本支持Lua（rmarkdown自带的Pandoc通常满足要求）；
• 子文档的YAML标题会被自动提取，若子文档未指定title，会使用兜底文本。

内容的提问来源于stack exchange，提问作者TimTeaFan