如何在DocFX中更改页脚?

Bla*_*ise 3 docfx

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

页脚

这是我所做的:

  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

但是,刷新文档页面时未显示更新。还有什么我想念的吗?

Yub*_*uby 5

尝试将步骤3、4合并为:docfx -t _exported_templates\default --serve

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

另一个快速的解决方案是添加_appFooter到全局元数据中,docfx.json如下所示:

"globalMetadata": {
  "_appFooter": "<span>Customized Footer</span>"
},
Run Code Online (Sandbox Code Playgroud)

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


Roe*_*elF 2

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

\n\n
exports.postTransform = function (model) {\n    model._appFooter = "<span>Copyright \xc2\xa9 2015-2017 MY COPYRIGHT<br>Generated by <strong>DocFX</strong></span>";\n    return model;\n}\n
Run Code Online (Sandbox Code Playgroud)\n