Как настроить автоматически сгенерированный Dokka html, чтобы включить верхний и нижний колонтитулы - PullRequest
0 голосов
/ 28 марта 2020

Я ищу способ настроить html, сгенерированный Dokka, для включения собственного заголовка и нижнего колонтитула. Ранее я использовал Doclava, чтобы переопределить шаблон для сгенерированного HTML, и мне было интересно, есть ли способ сделать это в Dokka. Просматривая их код, я наткнулся на функции appendHeader и appendFooter, но не был уверен, как можно переопределить эти методы. https://github.com/Kotlin/dokka/blob/de2f32d91fb6f564826ddd7644940452356e2080/core/src/main/kotlin/Formats/KotlinWebsiteHtmlFormatService.kt#L10

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

Любая помощь будет принята с благодарностью. Спасибо!

Редактировать: Закончилось создание хакерского bash сценария

head=`cat head.html`
header=`cat header.html`
footer=`cat footer.html`

find build/dokka -name "*.html" -type f -exec sed -i "s|</HEAD>|$head</HEAD>|g" {} \;
find .build/dokka -name "*.html" -type f -exec sed -i "s|<BODY>|<BODY>$header|g" {} \;
find build/dokka -name "*.html" -type f -exec sed -i "s|</BODY>|$footer</BODY>|g" {} \;

1 Ответ

0 голосов
/ 04 апреля 2020

Боюсь, сейчас это невозможно. По крайней мере, это не так просто. Вы можете отменить генерацию контента в StructuredFormatService и затем перекомпилировать dokka.

В dokka v0.11.0 мы добавили поддержку плагинов (и переписали докку с нуля), и эта функциональность является одним из запланированных плагинов

...