Mermaid Html Dokka plugin

Step 1: install

dependencies {
  dokkaPlugin("com.glureau:html-mermaid-dokka-plugin:0.1.0")
}

Step 2: put your Mermaid graphs in your code comments.

    /**
     * See the graph for more details:
     * ```mermaid
     * graph LR
     *   A[Christmas] -->|Get money| B(Go shopping)
     *   B --> C{Let me think}
     *   C -->|One| D[Laptop]
     *   C -->|Two| E[iPhone]
     *   C -->|Three| F[fa:fa-car Car]
     * ```
     * another one
     * ```mermaid
gantt
    title A Gantt Diagram
    dateFormat  YYYY-MM-DD
    section Section
    A task           :a1, 2014-01-01, 30d
    Another task     :after a1  , 20d
    section Another
    Task in sec      :2014-01-12  , 12d
    another task      : 24d
    * ```
*/
class CompositeSubscription

Step 3: enjoy your Dokka documentation

./gradlew dokkaHtml

img.png

GitHub

View Github