docfx - 如何更改 DocFX 中的页脚？

Question

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

这是我所做的：

1. 导出模板：

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

2. 更改页脚部分：

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

3. 使用更新的模板：

运行docfx -t _exported_templates\default。

4. 再次为网站服务

运行docfx docfx.json --serve。

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

Answer 1

尝试将步骤 3、4 合并到：docfx -t _exported_templates\default --serve。

说明：如果您_site在第 3 步之后打开构建输出，您应该会发现页脚实际上已更新。在第 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;
}