如何更改DocFX中的页脚？

Question

希望更改由DocFX生成的页脚版权信息。

by Apple

这就是我所做的：

1. 导出模板：

运行docfx template export default，获取文件夹_exported_templates\default

1. 更改页脚部分：

我更改的文件是。\ partials_footer.liquid 和。\ partials \ footer.tmpl.partial

1. 使用更新的模板：

运行docfx -t _exported_templates\default。

1. 再次提供网站

运行docfx docfx.json --serve。

但刷新文档页面时未显示更新。还有什么我错过的吗？

Answer 1

尝试将第3,4步合并到docfx -t _exported_templates\default --serve。

说明：如果在步骤3之后在_site中打开构建输出，则应该发现页脚实际上已更新。在第4步中，DocFX会在服务之前再次构建网站，因此最终您会找到原始页脚，因为此版本不使用您的自定义模板。

另一个快速解决方案是将_appFooter添加到docfx.json中的全局元数据中，例如：

"globalMetadata": {
  "_appFooter": "<span>Customized Footer</span>"
},

可以在此处找到完整的保留元数据列表：http://dotnet.github.io/docfx/tutorial/docfx.exe_user_manual.html#322-reserved-metadata

Answer 2

最简单的方法是直接更改模型。在模板中，创建一个名为conceptual.extension.js的文件，并使用以下代码：

exports.postTransform = function (model) {
    model._appFooter = "<span>Copyright © 2015-2017 MY COPYRIGHT<br>Generated by <strong>DocFX</strong></span>";
    return model;
}