Skip to content

Commit

Permalink
docs: added readme for testDokka.sh
Browse files Browse the repository at this point in the history
  • Loading branch information
berezinant committed Dec 20, 2023
1 parent 902e4a3 commit bf9ef76
Showing 1 changed file with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions testDokka.sh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
## Purpose
`.testDokka.sh` makes Dokka development and testing a bit faster

It compiles current Dokka version from the source code, \
publishes it to the local Maven repository, \
then runs the Dokka documentation generation against the specified project \
and finally runs a webserver to open the generated documentation in the browser.

## Usage

### Without parameters
By default it applied to the `./examples/gradle/dokka-gradle-example` project

```bash
./testDokka.sh
```

### Specify test project path

```bash
./testDokka.sh -d './examples/gradle/dokka-gradle-example'
```

### Specify Dokka version

```bash
./testDokka.sh -v "1.9.20-SNAPSHOT"
```

### Specify port

```bash
./testDokka.sh -p 8001
```

### All together

```bash
./testDokka.sh -d './examples/gradle/dokka-gradle-example' -v "1.9.20-SNAPSHOT" -p 8001
```


0 comments on commit bf9ef76

Please sign in to comment.