R CMD build构建包vignette时R Markdown主题未生效的问题咨询

我之前也碰到过一模一样的问题，核心原因是R CMD build在处理vignette时，默认会强制使用rmarkdown::html_vignette格式生成符合CRAN规范的轻量文档，这会直接覆盖你在YAML里指定的prettydoc::html_pretty输出格式。下面是具体的解决步骤：

步骤1：修改vignette的YAML配置 #

把vignette部分的引擎从knitr::rmarkdown替换成rmarkdown::render，这样就能绕过默认的html_vignette强制替换逻辑：

---
title: "Creating Pretty Documents from R Markdown"
subtitle: "The HPSTR Theme"
author: "Yixuan Qiu"
date: "`r Sys.Date()`"
output:
  prettydoc::html_pretty:
    theme: hpstr
    highlight: github
vignette: >
  %\VignetteIndexEntry{Creating Pretty Documents from R Markdown - The HPSTR Theme}
  %\VignetteEngine{rmarkdown::render}  # 关键修改：替换引擎
  %\VignetteEncoding{UTF-8}
---

步骤2：完善DESCRIPTION文件的依赖配置 #

在DESCRIPTION里把prettydoc添加到Suggests（如果你的包核心功能不依赖它）或Imports（如果核心功能需要用到它），同时保留knitr和rmarkdown的配置：

Package: prettydoc
Version: 0.2.1
...
VignetteBuilder: knitr, rmarkdown
Suggests:
    prettydoc,
    knitr,
    rmarkdown
...

步骤3：构建前确保依赖包已安装 #

R CMD build不会自动安装构建所需的依赖，所以先手动确认prettydoc、knitr和rmarkdown都已安装：

R -e "install.packages(c('prettydoc', 'knitr', 'rmarkdown'), repos='https://cran.r-project.org')"

步骤4：重新构建并安装包 #

按照标准流程重新执行构建和安装：

git clone https://github.com/yixuan/prettydoc.git
cd prettydoc
R CMD build .
R CMD INSTALL prettydoc_0.2.1.tar.gz

验证结果 #

打开R终端执行以下命令：

library(prettydoc)
vignette("hpstr")

现在应该能正常看到应用了hpstr主题的vignette页面了。

补充说明：如果你的包打算提交到CRAN，需要注意CRAN对vignette文件大小有要求，prettydoc生成的HTML会比默认的html_vignette大，可能需要提前和CRAN沟通，或者准备一个轻量版的vignette作为备选。

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