Как я могу настроить документацию Docfx (темы или шаблоны)?

Question

Я только начал использовать Docfx и создал базовую концептуальную документацию. Теперь я хочу внести некоторые коррективы в тему (логотип компании, возможно, некоторые изменения шрифта и т. Д.) Незначительные вещи.

Официальная документация только дает общее описание того, как создать новый шаблон. Раньше я никогда не пользовался языком шаблонов, поэтому я хотел бы пока избежать этого, если это возможно.

Мой вопрос: как я могу внести небольшие изменения в тему по умолчанию, например, внести некоторые изменения в CSS и, возможно, добавить внешние ресурсы (например, шрифт потрясающий)?

Нужно ли создавать целый шаблон (или его часть) или я могу как-то включить файл CSS? В документации упоминается theme вариант, но пока я не нашел примеров или существующих тем для изучения.

Простая ссылка на проект, который использует собственную тему или шаблон, уже была бы очень полезна. В репозитории docfx есть docfx.website.themes Я считаю, что там также есть папка и шаблон по умолчанию, но я не мог понять, какие файлы мне нужно будет предоставить, чтобы свернуть мои собственные.

Answer 1

1. Шаблон экспорта:
   • Бежать docfx template export default, тогда вы увидите шаблон по умолчанию в _exported_templates\default
2. Изменить темы в шаблоне по умолчанию, например:
   • Добавление внешнего ресурса: изменить styles\head.tmpl.partial
   • Изменение CSS: изменить styles\docfx.css или же styles\main.css
3. Используйте настроенный шаблон:
   • Бежать docfx -t _exported_templates\default, который будет использовать ваш настроенный шаблон!

ПРИМЕЧАНИЕ. Возможно, что DocFX обновит свои встроенные шаблоны при выпуске новой версии. Поэтому, пожалуйста, не забудьте повторно экспортировать шаблон, если вы перезаписали или зависели от этого шаблона в своем пользовательском шаблоне.