Skip to content

Commit 4d19077

Browse files
committed
Create docs/README.md
1 parent ba2cfca commit 4d19077

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

docs/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# docs
2+
3+
Documentation files are placed in the `public` directory.
4+
5+
Use the following command to generate the documentation:
6+
7+
```bash
8+
./gradlew dokkaGenerateHtml
9+
```
10+
11+
Then you can open the `index.html` file in the `public/dokka` directory.
12+
13+
Use `yarn dev` to preview the documentation locally.
14+
15+
> [!INFO]
16+
> Put /docker-kotlin in the URL to be able to access the documentation.

0 commit comments

Comments
 (0)