Skip to content

Commit 3ba98fc

Browse files
committed
docs: Convert quickstart dependencies to tabs view
1 parent 1c95b62 commit 3ba98fc

File tree

3 files changed

+34
-27
lines changed

3 files changed

+34
-27
lines changed

docs/quickstart.md

Lines changed: 13 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
---
22
sidebar_position: 2
33
---
4+
import Tabs from '@theme/Tabs';
5+
import TabItem from '@theme/TabItem';
6+
import CodeBlock from '@theme/CodeBlock';
7+
import CodeSpringwolfGroovy from '!!raw-loader!./snippets/_springwolf_groovy.md';
8+
import CodeSpringwolfMaven from '!!raw-loader!./snippets/_springwolf_maven.md';
49

510
# Quickstart
611

@@ -10,33 +15,14 @@ sidebar_position: 2
1015

1116
Add the following dependencies:
1217

13-
### [Groovy](#tab/groovy-dependencies)
14-
```groovy
15-
dependencies {
16-
// Provides the documentation API
17-
implementation 'io.github.springwolf:springwolf-kafka:0.8.0'
18-
19-
// Provides the UI - optional (recommended)
20-
runtimeOnly 'io.github.springwolf:springwolf-ui:0.5.0'
21-
}
22-
```
23-
### [Maven](#tab/maven-dependencies)
24-
```xml
25-
<dependencies>
26-
<!-- Provides the documentation API -->
27-
<dependency>
28-
<groupId>io.github.springwolf</groupId>
29-
<artifactId>springwolf-kafka</artifactId>
30-
<version>0.8.0</version>
31-
</dependency>
32-
<!-- Provides the UI - optional (recommended) -->
33-
<dependency>
34-
<groupId>io.github.springwolf</groupId>
35-
<artifactId>springwolf-ui</artifactId>
36-
<version>0.5.0</version>
37-
</dependency>
38-
</dependencies>
39-
```
18+
<Tabs>
19+
<TabItem value="Groovy" label="Groovy" default>
20+
<CodeBlock language="groovy">{CodeSpringwolfGroovy}</CodeBlock>
21+
</TabItem>
22+
<TabItem value="Maven" label="Maven">
23+
<CodeBlock language="xml">{CodeSpringwolfMaven}</CodeBlock>
24+
</TabItem>
25+
</Tabs>
4026

4127
## Configuration Class
4228

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
dependencies {
2+
// Provides the documentation API
3+
implementation 'io.github.springwolf:springwolf-kafka:0.8.0'
4+
5+
// Provides the UI - optional (recommended)
6+
runtimeOnly 'io.github.springwolf:springwolf-ui:0.5.0'
7+
}

docs/snippets/_springwolf_maven.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<dependencies>
2+
<!-- Provides the documentation API -->
3+
<dependency>
4+
<groupId>io.github.springwolf</groupId>
5+
<artifactId>springwolf-kafka</artifactId>
6+
<version>0.8.0</version>
7+
</dependency>
8+
<!-- Provides the UI - optional (recommended) -->
9+
<dependency>
10+
<groupId>io.github.springwolf</groupId>
11+
<artifactId>springwolf-ui</artifactId>
12+
<version>0.5.0</version>
13+
</dependency>
14+
</dependencies>

0 commit comments

Comments
 (0)