R包relper的NEWS.md在pkgdown站点无法正常显示求助
relper包NEWS.md在pkgdown中显示异常的排查与修复
可能成因及修复方案
1. 版本标题或顺序问题
pkgdown对版本号的解析依赖严格的层级和排序逻辑:确保主版本用#、次版本用##的层级结构,同时按语义化版本降序排列(比如3.6.8放在3.5.0之前是正确的,若顺序混乱可能导致展示错乱)。
2. Markdown格式空格不规范
pkgdown的解析器对空格敏感度远高于RStudio预览:
- 加粗标题(如
**Improvements:**)后必须换行,列表项的缩进要统一(避免混合不同数量的空格缩进) - 代码格式(如
prefix)的反引号前后不要加多余空格,防止解析失效
3. 特殊字符未转义
列表项中的...可能被pkgdown误判为特殊语法,建议转义为\...,避免展示异常
修复后的NEWS.md示例
# relper 3 (Calculations all the way) To improve data analysis, I added functions that compute metrics and other calculations. ## 3.6.8 **Improvements:** - Parameter `prefix` to the function `dttm_vars` - Use of `format_num` to breaks labels, with `\...` in the function `plt_scale_y_mirror` ## 3.5.0 **Addition:** - Function `stat_missing_values`.
额外排查步骤
- 执行
pkgdown::check_news()命令,直接获取NEWS.md的格式错误提示 - 更新pkgdown到最新版本:
install.packages("pkgdown"),规避旧版本的解析bug
内容的提问来源于stack exchange,提问作者Vinícius Félix
相关产品推荐
相关产品推荐

