Как использовать Dokka для создания документов вроде Kotlinlang.org - PullRequest
2 голосов
/ 08 июля 2019

AFAIK Документация Kotlin была сделана с использованием Dokka.Но примеры, приведенные в Readme Докки, генерируют только ультраосновные файлы веб-страниц / уценок без какой-либо элегантности.

Это просто выглядит так

enter image description here

Вот еще один от Атриум , документы ссылка .

enter image description here

Мне интересно, что я делаю что-то не так.

Я также просмотрел страницу с проблемами и просматривал другие проекты с открытым исходным кодом на github, которые использовали Dokka , и результатвсегда одно и то же.

Теперь хорошим примером того, как инструмент, который генерирует красивую документацию, будет Jazzy от Realm для Swift / Obj-C.Использовать его так же просто, как запустить одну команду на терминале.

Вот пример документации, созданной с использованием Jazzy

enter image description here

Дальнейшие исследования показывают, что мне, возможно, придется использовать сторонние инструменты, такие как Gitbook или Jekyll для создания документации, которую я ищу, разве это единственный способ?

...