Doc-Generator

Doc-generator is a small library utility for the KordEx library that automatically generates documentation for commands within your KordEx bot.

This project is licensed under the MIT License

---

Translation Status

You can contribute to the translations via this link

Translations are hosted on weblate

---

Installation

Latest version

Maven:

<!-- Adding the Snapshots repository (Optional) -->
<repository>
    <id>snapshots-repo</id>
    <url>https://oss.sonatype.org/content/repositories/snapshots</url>
    <releases>
        <enabled>false</enabled>
    </releases>
    <snapshots>
        <enabled>true</enabled>
    </snapshots>
</repository>

<!-- Adding the dependency. Replace TAG with the latest version -->
<dependency>
    <groupId>org.hyacinthbots</groupId>
    <artifactId>doc-generator</artifactId>
    <version>TAG</version>
</dependency>

Gradle (Groovy)

repositories {
    mavenCentral()
    // Optionally add the snapshots repository
    maven {
        name "Sonatype snapshots"
        url "https://oss.sonatype.org/content/repositories/snapshots"
    }
}

// Adding the dependency. Replace TAG with the latest version
dependencies {
    implementation('org.hyacinthbots:doc-generator:TAG')
}

Gradle (Kotlin)

repositories {
    mavenCentral()
    // Optionally add the snapshots repository
    maven {
        name = "Sonatype Snapshots"
        url = uri("https://oss.sonatype.org/content/repositories/snapshots")
    }
}

// Adding the dependency. Replace TAG with latest version
dependencies {
    implementation("org.hyacinthbots:doc-generator:TAG")
}

Getting started

Once the dependency has been added, navigate to the usage guide for how to get started.