2017-07-07 27 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