Skip to content

Commit

Permalink
Added doc links for Arrow module
Browse files Browse the repository at this point in the history
  • Loading branch information
robfletcher committed Sep 15, 2019
1 parent c402b18 commit 3f9c765
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 1 deletion.
4 changes: 4 additions & 0 deletions site/src/orchid/resources/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@ theme:
- type: 'page'
title: 'Gradle Module'
itemId: 'strikt.gradle.testkit'
- type: 'page'
title: 'Arrow Module'
itemId: 'strikt.arrow'
- type: 'page'
title: 'Jackson Module'
itemId: 'strikt.jackson'
Expand Down Expand Up @@ -86,6 +89,7 @@ services:
kotlindoc:
sourceDirs:
- '../../../../strikt-core/src/main/kotlin/'
- '../../../../strikt-arrow/src/main/kotlin/'
- '../../../../strikt-gradle/src/main/kotlin/'
- '../../../../strikt-jackson/src/main/kotlin/'
- '../../../../strikt-java-time/src/main/kotlin/'
Expand Down
2 changes: 2 additions & 0 deletions site/src/orchid/resources/data.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
contributors:
- name: Stefan Anđelković
link: https://github.com/sandjelkovic
- name: Alphonse Bendt
link: https://github.com/abendt
- name: Casey Brooks
link: https://github.com/cjbrooks12
- name: Adriel Café
Expand Down
14 changes: 13 additions & 1 deletion site/src/orchid/resources/wiki/additional-modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,20 @@

In addition to the core functionality provided by the `strikt-core` module, Strikt has the following optional modules:

## Arrow

Extensions for assertions and traversals on types from the [Arrow](https://arrow-kt.io/)'s functional programming library.
See the {{ anchor('API docs', 'strikt.arrow') }}.

Add the following to your dependencies:

```kotlin
testImplementation("io.strikt:strikt-arrow:{{ site.version }}")
```

## Gradle

Extensions for assertions and travels on [Gradle](https://github.com/gradle/gradle)'s test kit.
Extensions for assertions and traversals on [Gradle](https://github.com/gradle/gradle)'s test kit.
See the {{ anchor('API docs', 'strikt.gradle.testkit') }}.

Add the following to your dependencies:
Expand Down Expand Up @@ -68,6 +79,7 @@ For example:
```kotlin
dependencies {
testImplementation(platform("io.strikt:strikt-bom:{{ site.version }}"))
testImplementation("io.strikt:strikt-arrow")
testImplementation("io.strikt:strikt-jackson")
testImplementation("io.strikt:strikt-java-time")
}
Expand Down

0 comments on commit 3f9c765

Please sign in to comment.