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

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

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

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

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

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


person enzi    schedule 17.03.2016    source источник


Ответы (1)


  1. Export template:
    • Run docfx template export default, then you'll see default template in _exported_templates\default
  2. Change themes in default template, e.g:
    • Adding external resource: modify styles\head.tmpl.partial
    • Изменение CSS: измените styles\docfx.css или styles\main.css
  3. Use customized template:
    • Run docfx -t _exported_templates\default, which will use your customized template!

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

person Yuby    schedule 21.05.2016
comment
Знаете ли вы, как управлять шаблоном для использования в файле docfx.json? Или просто заменить/переопределить шаблон по умолчанию, который используется? - person Marc; 17.04.2018
comment
@Marc Вы можете использовать шаблон: [по умолчанию, _exported_templates\по умолчанию]. Вот пример: github.com/dotnet/docfx /блоб/ - person Yuby; 17.04.2018
comment
Это я уже сделал. Но если я не укажу аргумент -t ..., будет использоваться шаблон по умолчанию. - person Marc; 18.04.2018
comment
Заказ такой же, как образец? Последний перезапишет первый в template. - person Yuby; 18.04.2018
comment
Я использую 2.36.2, и единственный способ заставить его работать — это экспортировать, редактировать на месте и использовать параметр -t с этой папкой. Сайт говорит, что вы должны копировать только измененные файлы, но это не работает. - person escape-llc; 29.06.2018
comment
@escape-llc Не уверен, в чем проблема. Это может помочь открыть задачу с подробными инструкциями по воспроизведению на github.com/dotnet/docfx/issues/ новый - person Yuby; 02.07.2018