Org-mode导出HTML时如何显示头部参数与代码块名称？

方法一：利用内置导出参数调整 #

Org-mode提供了内置的导出控制选项，可通过全局或局部设置开启代码块名称与参数的导出：

• 全局生效：在Emacs配置文件中添加以下代码，让所有代码块默认导出名称和头部参数：

  (setq org-html-src-block-default-attributes
        '(:name t :parameters t :exports "both"))
  

  其中:name t控制导出代码块名称，:parameters t控制导出头部参数，:exports "both"确保代码块和执行结果都被导出。
• 局部生效：若仅需针对单个代码块设置，可添加局部属性：

  #+ATTR_HTML: :name t :parameters t
  #+name: call-example
  #+begin_src emacs-lisp :var bar="baz" :exports both
    (sit-for 1)
    (message "bar=%S" bar)
  #+end_src
  

方法二：自定义HTML导出模板 #

如果内置参数不够灵活，可自定义代码块的HTML导出模板，精准控制显示样式：

1. 定义处理代码块的自定义函数，提取名称和参数并生成对应HTML内容：

   (defun my-org-html-src-block (src-block contents info)
     (let* ((name (org-element-property :name src-block))
            (parameters (org-element-property :parameters src-block))
            (default-output (org-html-src-block src-block contents info))
            (header-content ""))
       ;; 拼接名称和参数的HTML片段
       (when name
         (setq header-content (concat header-content "<div class=\"src-name\">代码块名称: " name "</div>")))
       (when parameters
         (setq header-content (concat header-content "<div class=\"src-params\">头部参数: " parameters "</div>")))
       ;; 组合自定义头部与默认代码块输出
       (concat header-content default-output)))
   

2. 将该函数注册为Org HTML导出的代码块处理器：

   (add-to-list 'org-html-element-translator
                '(src-block . my-org-html-src-block)
                t)
   

   导出后代码块上方会显示名称和参数，还可通过CSS自定义.src-name和.src-params的样式。

方法三：通过注释嵌入参数到代码块 #

利用Org-babel钩子，在导出前自动将名称和参数以注释形式嵌入代码块内容，导出时自然显示：

(defun my-add-src-header-to-code (body params)
  (let* ((name (cdr (assoc :name params)))
         (param-str (mapconcat (lambda (p) (format "%s=%s" (car p) (cdr p))) params " ")))
    (concat
     (when name (format ";; 代码块名称: %s\n" name))
     (when param-str (format ";; 头部参数: %s\n" param-str))
     body)))

(add-hook 'org-babel-pre-tangle-hook 'my-add-src-header-to-code)

这种方式会把参数和名称作为代码注释放在代码块开头，适合希望参数与代码内容绑定展示的场景。

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