/dokka-hugo-plugin

Dokka plugin used to generate https://hwsecurity.dev/reference/hwsecurity/

Primary LanguageKotlinApache License 2.0Apache-2.0

Dokka Hugo Plugin

Extends Dokka with a Hugo Plugin.

Build

./gradlew build

Try Local Build

./gradlew publishToMavenLocal

Dependency

allprojects {
    repositories {
        ...
        maven { url 'https://jitpack.io' }
    }
}
tasks.register("dokkaHugo", DokkaTask) {
    dependencies {
        dokkaHugoPlugin 'com.github.cotechde:dokka-hugo-plugin:master-SNAPSHOT'
    }
}

Requirements

  • Currently uses the Hugo academic theme
  • Requires special docs template called "reference"
  • Requires shortcode to insert markdown in html. Put md.html in your "shortcodes" folder with the content:
{{ .Inner }}