Skip to content

Commit 67e81b7

Browse files
committed
docs: add version catalog tutorial
1 parent 4511ec3 commit 67e81b7

14 files changed

+323
-0
lines changed

docs-source/src/en/library/hikage-compiler.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,48 @@ dependencies {
5656
}
5757
```
5858

59+
### Version Catalog
60+
61+
Add dependency in your project's `gradle/libs.versions.toml`.
62+
63+
```toml
64+
[versions]
65+
ksp = "<ksp-version>"
66+
hikage-compiler = "<version>"
67+
68+
[plugins]
69+
ksp = { id = "com.google.devtools.ksp", version.ref = "ksp" }
70+
71+
[libraries]
72+
hikage-compiler = { module = "com.highcapable.hikage:hikage-compiler", version.ref = "hikage-compiler" }
73+
```
74+
75+
Configure dependency in your root project `build.gradle.kts`.
76+
77+
```kotlin
78+
plugins {
79+
// ...
80+
alias(libs.plugins.ksp) apply false
81+
}
82+
```
83+
84+
Configure dependency in your project `build.gradle.kts`.
85+
86+
```kotlin
87+
plugins {
88+
// ...
89+
alias(libs.plugins.ksp)
90+
}
91+
92+
dependencies {
93+
// ...
94+
ksp(libs.hikage.compiler)
95+
}
96+
```
97+
98+
Please change `<version>` to the version displayed at the top of this document,
99+
and change `<ksp-version>` to the KSP version corresponding to the Kotlin version currently used by your project.
100+
59101
### Traditional Method
60102

61103
Configure dependency in your root project `build.gradle.kts`.

docs-source/src/en/library/hikage-core.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,26 @@ Configure dependency in your project `build.gradle.kts`.
2929
implementation(com.highcapable.hikage.hikage.core)
3030
```
3131

32+
### Version Catalog
33+
34+
Add dependency in your project's `gradle/libs.versions.toml`.
35+
36+
```toml
37+
[versions]
38+
hikage-core = "<version>"
39+
40+
[libraries]
41+
hikage-core = { module = "com.highcapable.hikage:hikage-core", version.ref = "hikage-core" }
42+
```
43+
44+
Configure dependency in your project `build.gradle.kts`.
45+
46+
```kotlin
47+
implementation(libs.hikage.core)
48+
```
49+
50+
Please change `<version>` to the version displayed at the top of this document.
51+
3252
### Traditional Method
3353

3454
Configure dependency in your project `build.gradle.kts`.

docs-source/src/en/library/hikage-extension-betterandroid.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,26 @@ Configure dependency in your project `build.gradle.kts`.
2929
implementation(com.highcapable.hikage.hikage.extension.betterandroid)
3030
```
3131

32+
### Version Catalog
33+
34+
Add dependency in your project's `gradle/libs.versions.toml`.
35+
36+
```toml
37+
[versions]
38+
hikage-extension-betterandroid = "<version>"
39+
40+
[libraries]
41+
hikage-extension-betterandroid = { module = "com.highcapable.hikage:hikage-extension-betterandroid", version.ref = "hikage-extension-betterandroid" }
42+
```
43+
44+
Configure dependency in your project `build.gradle.kts`.
45+
46+
```kotlin
47+
implementation(libs.hikage.extension.betterandroid)
48+
```
49+
50+
Please change `<version>` to the version displayed at the top of this document.
51+
3252
### Traditional Method
3353

3454
Configure dependency in your project `build.gradle.kts`.

docs-source/src/en/library/hikage-extension-compose.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,26 @@ Configure dependency in your project `build.gradle.kts`.
3737
implementation(com.highcapable.hikage.hikage.extension.compose)
3838
```
3939

40+
### Version Catalog
41+
42+
Add dependency in your project's `gradle/libs.versions.toml`.
43+
44+
```toml
45+
[versions]
46+
hikage-extension-compose = "<version>"
47+
48+
[libraries]
49+
hikage-extension-compose = { module = "com.highcapable.hikage:hikage-extension-compose", version.ref = "hikage-extension-compose" }
50+
```
51+
52+
Configure dependency in your project `build.gradle.kts`.
53+
54+
```kotlin
55+
implementation(libs.hikage.extension.compose)
56+
```
57+
58+
Please change `<version>` to the version displayed at the top of this document.
59+
4060
### Traditional Method
4161

4262
Configure dependency in your project `build.gradle.kts`.

docs-source/src/en/library/hikage-extension.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,26 @@ Configure dependency in your project `build.gradle.kts`.
2929
implementation(com.highcapable.hikage.hikage.extension)
3030
```
3131

32+
### Version Catalog
33+
34+
Add dependency in your project's `gradle/libs.versions.toml`.
35+
36+
```toml
37+
[versions]
38+
hikage-extension = "<version>"
39+
40+
[libraries]
41+
hikage-extension = { module = "com.highcapable.hikage:hikage-extension", version.ref = "hikage-extension" }
42+
```
43+
44+
Configure dependency in your project `build.gradle.kts`.
45+
46+
```kotlin
47+
implementation(libs.hikage.extension)
48+
```
49+
50+
Please change `<version>` to the version displayed at the top of this document.
51+
3252
### Traditional Method
3353

3454
Configure dependency in your project `build.gradle.kts`.

docs-source/src/en/library/hikage-widget-androidx.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,26 @@ Configure dependency in your project `build.gradle.kts`.
2929
implementation(com.highcapable.hikage.hikage.widget.androidx)
3030
```
3131

32+
### Version Catalog
33+
34+
Add dependency in your project's `gradle/libs.versions.toml`.
35+
36+
```toml
37+
[versions]
38+
hikage-widget-androidx = "<version>"
39+
40+
[libraries]
41+
hikage-widget-androidx = { module = "com.highcapable.hikage:hikage-widget-androidx", version.ref = "hikage-widget-androidx" }
42+
```
43+
44+
Configure dependency in your project `build.gradle.kts`.
45+
46+
```kotlin
47+
implementation(libs.hikage.widget.androidx)
48+
```
49+
50+
Please change `<version>` to the version displayed at the top of this document.
51+
3252
### Traditional Method
3353

3454
Configure dependency in your project `build.gradle.kts`.

docs-source/src/en/library/hikage-widget-material.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,26 @@ Configure dependency in your project `build.gradle.kts`.
2929
implementation(com.highcapable.hikage.hikage.widget.material)
3030
```
3131

32+
### Version Catalog
33+
34+
Add dependency in your project's `gradle/libs.versions.toml`.
35+
36+
```toml
37+
[versions]
38+
hikage-widget-material = "<version>"
39+
40+
[libraries]
41+
hikage-widget-material = { module = "com.highcapable.hikage:hikage-widget-material", version.ref = "hikage-widget-material" }
42+
```
43+
44+
Configure dependency in your project `build.gradle.kts`.
45+
46+
```kotlin
47+
implementation(libs.hikage.widget.material)
48+
```
49+
50+
Please change `<version>` to the version displayed at the top of this document.
51+
3252
### Traditional Method
3353

3454
Configure dependency in your project `build.gradle.kts`.

docs-source/src/zh-cn/library/hikage-compiler.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,47 @@ dependencies {
5656
}
5757
```
5858

59+
### Version Catalog
60+
61+
在你的项目 `gradle/libs.versions.toml` 中添加依赖。
62+
63+
```toml
64+
[versions]
65+
ksp = "<ksp-version>"
66+
hikage-compiler = "<version>"
67+
68+
[plugins]
69+
ksp = { id = "com.google.devtools.ksp", version.ref = "ksp" }
70+
71+
[libraries]
72+
hikage-compiler = { module = "com.highcapable.hikage:hikage-compiler", version.ref = "hikage-compiler" }
73+
```
74+
75+
在你的根项目 `build.gradle.kts` 中配置依赖。
76+
77+
```kotlin
78+
plugins {
79+
// ...
80+
alias(libs.plugins.ksp) apply false
81+
}
82+
```
83+
84+
在你的项目 `build.gradle.kts` 中配置依赖。
85+
86+
```kotlin
87+
plugins {
88+
// ...
89+
alias(libs.plugins.ksp)
90+
}
91+
92+
dependencies {
93+
// ...
94+
ksp(libs.hikage.compiler)
95+
}
96+
```
97+
98+
请将 `<version>` 修改为此文档顶部显示的版本,并将 `<ksp-version>` 修改为你项目当前使用的 Kotlin 版本对应的 KSP 版本。
99+
59100
### 传统方式
60101

61102
在你的根项目 `build.gradle.kts` 中配置依赖。

docs-source/src/zh-cn/library/hikage-core.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,26 @@ libraries:
2929
implementation(com.highcapable.hikage.hikage.core)
3030
```
3131

32+
### Version Catalog
33+
34+
在你的项目 `gradle/libs.versions.toml` 中添加依赖。
35+
36+
```toml
37+
[versions]
38+
hikage-core = "<version>"
39+
40+
[libraries]
41+
hikage-core = { module = "com.highcapable.hikage:hikage-core", version.ref = "hikage-core" }
42+
```
43+
44+
在你的项目 `build.gradle.kts` 中配置依赖。
45+
46+
```kotlin
47+
implementation(libs.hikage.core)
48+
```
49+
50+
请将 `<version>` 修改为此文档顶部显示的版本。
51+
3252
### 传统方式
3353

3454
在你的项目 `build.gradle.kts` 中配置依赖。

docs-source/src/zh-cn/library/hikage-extension-betterandroid.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,26 @@ libraries:
2929
implementation(com.highcapable.hikage.hikage.extension.betterandroid)
3030
```
3131

32+
### Version Catalog
33+
34+
在你的项目 `gradle/libs.versions.toml` 中添加依赖。
35+
36+
```toml
37+
[versions]
38+
hikage-extension-betterandroid = "<version>"
39+
40+
[libraries]
41+
hikage-extension-betterandroid = { module = "com.highcapable.hikage:hikage-extension-betterandroid", version.ref = "hikage-extension-betterandroid" }
42+
```
43+
44+
在你的项目 `build.gradle.kts` 中配置依赖。
45+
46+
```kotlin
47+
implementation(libs.hikage.extension.betterandroid)
48+
```
49+
50+
请将 `<version>` 修改为此文档顶部显示的版本。
51+
3252
### 传统方式
3353

3454
在你的项目 `build.gradle.kts` 中配置依赖。

0 commit comments

Comments
 (0)