Skip to content

Commit

Permalink
Fix README
Browse files Browse the repository at this point in the history
  • Loading branch information
Gregory Lureau committed Apr 3, 2022
1 parent 3efc354 commit 355bccd
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Mermaid Html Dokka plugin
# Html [Mermaid](https://mermaid-js.github.io/mermaid/#/) Dokka plugin

## Step 1: install

Expand All @@ -8,7 +8,9 @@ dependencies {
}
```

## Step 2: put your Mermaid graphs in your code comments.
## Step 2: write [Mermaid](https://mermaid-js.github.io/mermaid/#/) graphs

You can write them on markdown files for [modules/packages](https://kotlinlang.org/docs/kotlin-doc.html#module-and-package-documentation) or directly from any comment in your code.

```kotlin
/**
Expand All @@ -33,16 +35,15 @@ gantt
Task in sec :2014-01-12 , 12d
another task : 24d
* ```
*/
*/
class CompositeSubscription
```

## Step 3: enjoy your Dokka documentation

`./gradlew dokkaHtml`
`./gradlew dokkaHtml` or `./gradlew dokkaHtmlMultiModule` ->

![img.png](doc/img.png)
<<<<<<< HEAD

# Theming & customization

Expand All @@ -63,7 +64,7 @@ tasks.dokkaHtmlMultiModule {
}
```

You can also specify the theme by graph, with the `%%{init: ...}%%` block ([documentation](https://github.com/mermaid-js/mermaid/blob/develop/docs/theming.md#customizing-themes--with-themevariables)).
You can also specify the theme for each graph, with the `%%{init: ...}%%` block ([documentation](https://github.com/mermaid-js/mermaid/blob/develop/docs/theming.md#customizing-themes--with-themevariables)).

For example with `%%{init: {'theme': 'base', 'themeVariables': { 'primaryColor': '#DD0000'}}}%%`
```mermaid
Expand All @@ -83,5 +84,3 @@ graph TD
G
end
```
=======
>>>>>>> main

0 comments on commit 355bccd

Please sign in to comment.