Как изменить нижний колонтитул в 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

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;
}