2017-07-07 28 views
2

只希望更改由DocFX生成的页脚版权信息。如何更改DocFX中的页脚?

footer

这里是我做了什么:

  1. 导出模板:

运行docfx template export default,得到一个文件夹_exported_templates\default

  • 更改页脚部分:
  • 我已经改变的文件是\ partials_footer.liquid\谐音\ footer.tmpl.partial

  • 使用更新后的模板:。
  • 运行docfx -t _exported_templates\default

  • 再次即成站点
  • 运行docfx docfx.json --serve

    但是,刷新文档页面时不会显示更新。还有什么我错过了吗?

    回答

    1

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

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

    尝试合并步骤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