docs: add version catalog tutorial

This commit is contained in:
2025-06-05 19:16:50 +08:00
parent 4511ec329f
commit 67e81b736b
14 changed files with 323 additions and 0 deletions

View File

@@ -56,6 +56,48 @@ dependencies {
} }
``` ```
### Version Catalog
Add dependency in your project's `gradle/libs.versions.toml`.
```toml
[versions]
ksp = "<ksp-version>"
hikage-compiler = "<version>"
[plugins]
ksp = { id = "com.google.devtools.ksp", version.ref = "ksp" }
[libraries]
hikage-compiler = { module = "com.highcapable.hikage:hikage-compiler", version.ref = "hikage-compiler" }
```
Configure dependency in your root project `build.gradle.kts`.
```kotlin
plugins {
// ...
alias(libs.plugins.ksp) apply false
}
```
Configure dependency in your project `build.gradle.kts`.
```kotlin
plugins {
// ...
alias(libs.plugins.ksp)
}
dependencies {
// ...
ksp(libs.hikage.compiler)
}
```
Please change `<version>` to the version displayed at the top of this document,
and change `<ksp-version>` to the KSP version corresponding to the Kotlin version currently used by your project.
### Traditional Method ### Traditional Method
Configure dependency in your root project `build.gradle.kts`. Configure dependency in your root project `build.gradle.kts`.

View File

@@ -29,6 +29,26 @@ Configure dependency in your project `build.gradle.kts`.
implementation(com.highcapable.hikage.hikage.core) implementation(com.highcapable.hikage.hikage.core)
``` ```
### Version Catalog
Add dependency in your project's `gradle/libs.versions.toml`.
```toml
[versions]
hikage-core = "<version>"
[libraries]
hikage-core = { module = "com.highcapable.hikage:hikage-core", version.ref = "hikage-core" }
```
Configure dependency in your project `build.gradle.kts`.
```kotlin
implementation(libs.hikage.core)
```
Please change `<version>` to the version displayed at the top of this document.
### Traditional Method ### Traditional Method
Configure dependency in your project `build.gradle.kts`. Configure dependency in your project `build.gradle.kts`.

View File

@@ -29,6 +29,26 @@ Configure dependency in your project `build.gradle.kts`.
implementation(com.highcapable.hikage.hikage.extension.betterandroid) implementation(com.highcapable.hikage.hikage.extension.betterandroid)
``` ```
### Version Catalog
Add dependency in your project's `gradle/libs.versions.toml`.
```toml
[versions]
hikage-extension-betterandroid = "<version>"
[libraries]
hikage-extension-betterandroid = { module = "com.highcapable.hikage:hikage-extension-betterandroid", version.ref = "hikage-extension-betterandroid" }
```
Configure dependency in your project `build.gradle.kts`.
```kotlin
implementation(libs.hikage.extension.betterandroid)
```
Please change `<version>` to the version displayed at the top of this document.
### Traditional Method ### Traditional Method
Configure dependency in your project `build.gradle.kts`. Configure dependency in your project `build.gradle.kts`.

View File

@@ -37,6 +37,26 @@ Configure dependency in your project `build.gradle.kts`.
implementation(com.highcapable.hikage.hikage.extension.compose) implementation(com.highcapable.hikage.hikage.extension.compose)
``` ```
### Version Catalog
Add dependency in your project's `gradle/libs.versions.toml`.
```toml
[versions]
hikage-extension-compose = "<version>"
[libraries]
hikage-extension-compose = { module = "com.highcapable.hikage:hikage-extension-compose", version.ref = "hikage-extension-compose" }
```
Configure dependency in your project `build.gradle.kts`.
```kotlin
implementation(libs.hikage.extension.compose)
```
Please change `<version>` to the version displayed at the top of this document.
### Traditional Method ### Traditional Method
Configure dependency in your project `build.gradle.kts`. Configure dependency in your project `build.gradle.kts`.

View File

@@ -29,6 +29,26 @@ Configure dependency in your project `build.gradle.kts`.
implementation(com.highcapable.hikage.hikage.extension) implementation(com.highcapable.hikage.hikage.extension)
``` ```
### Version Catalog
Add dependency in your project's `gradle/libs.versions.toml`.
```toml
[versions]
hikage-extension = "<version>"
[libraries]
hikage-extension = { module = "com.highcapable.hikage:hikage-extension", version.ref = "hikage-extension" }
```
Configure dependency in your project `build.gradle.kts`.
```kotlin
implementation(libs.hikage.extension)
```
Please change `<version>` to the version displayed at the top of this document.
### Traditional Method ### Traditional Method
Configure dependency in your project `build.gradle.kts`. Configure dependency in your project `build.gradle.kts`.

View File

@@ -29,6 +29,26 @@ Configure dependency in your project `build.gradle.kts`.
implementation(com.highcapable.hikage.hikage.widget.androidx) implementation(com.highcapable.hikage.hikage.widget.androidx)
``` ```
### Version Catalog
Add dependency in your project's `gradle/libs.versions.toml`.
```toml
[versions]
hikage-widget-androidx = "<version>"
[libraries]
hikage-widget-androidx = { module = "com.highcapable.hikage:hikage-widget-androidx", version.ref = "hikage-widget-androidx" }
```
Configure dependency in your project `build.gradle.kts`.
```kotlin
implementation(libs.hikage.widget.androidx)
```
Please change `<version>` to the version displayed at the top of this document.
### Traditional Method ### Traditional Method
Configure dependency in your project `build.gradle.kts`. Configure dependency in your project `build.gradle.kts`.

View File

@@ -29,6 +29,26 @@ Configure dependency in your project `build.gradle.kts`.
implementation(com.highcapable.hikage.hikage.widget.material) implementation(com.highcapable.hikage.hikage.widget.material)
``` ```
### Version Catalog
Add dependency in your project's `gradle/libs.versions.toml`.
```toml
[versions]
hikage-widget-material = "<version>"
[libraries]
hikage-widget-material = { module = "com.highcapable.hikage:hikage-widget-material", version.ref = "hikage-widget-material" }
```
Configure dependency in your project `build.gradle.kts`.
```kotlin
implementation(libs.hikage.widget.material)
```
Please change `<version>` to the version displayed at the top of this document.
### Traditional Method ### Traditional Method
Configure dependency in your project `build.gradle.kts`. Configure dependency in your project `build.gradle.kts`.

View File

@@ -56,6 +56,47 @@ dependencies {
} }
``` ```
### Version Catalog
在你的项目 `gradle/libs.versions.toml` 中添加依赖。
```toml
[versions]
ksp = "<ksp-version>"
hikage-compiler = "<version>"
[plugins]
ksp = { id = "com.google.devtools.ksp", version.ref = "ksp" }
[libraries]
hikage-compiler = { module = "com.highcapable.hikage:hikage-compiler", version.ref = "hikage-compiler" }
```
在你的根项目 `build.gradle.kts` 中配置依赖。
```kotlin
plugins {
// ...
alias(libs.plugins.ksp) apply false
}
```
在你的项目 `build.gradle.kts` 中配置依赖。
```kotlin
plugins {
// ...
alias(libs.plugins.ksp)
}
dependencies {
// ...
ksp(libs.hikage.compiler)
}
```
请将 `<version>` 修改为此文档顶部显示的版本,并将 `<ksp-version>` 修改为你项目当前使用的 Kotlin 版本对应的 KSP 版本。
### 传统方式 ### 传统方式
在你的根项目 `build.gradle.kts` 中配置依赖。 在你的根项目 `build.gradle.kts` 中配置依赖。

View File

@@ -29,6 +29,26 @@ libraries:
implementation(com.highcapable.hikage.hikage.core) implementation(com.highcapable.hikage.hikage.core)
``` ```
### Version Catalog
在你的项目 `gradle/libs.versions.toml` 中添加依赖。
```toml
[versions]
hikage-core = "<version>"
[libraries]
hikage-core = { module = "com.highcapable.hikage:hikage-core", version.ref = "hikage-core" }
```
在你的项目 `build.gradle.kts` 中配置依赖。
```kotlin
implementation(libs.hikage.core)
```
请将 `<version>` 修改为此文档顶部显示的版本。
### 传统方式 ### 传统方式
在你的项目 `build.gradle.kts` 中配置依赖。 在你的项目 `build.gradle.kts` 中配置依赖。

View File

@@ -29,6 +29,26 @@ libraries:
implementation(com.highcapable.hikage.hikage.extension.betterandroid) implementation(com.highcapable.hikage.hikage.extension.betterandroid)
``` ```
### Version Catalog
在你的项目 `gradle/libs.versions.toml` 中添加依赖。
```toml
[versions]
hikage-extension-betterandroid = "<version>"
[libraries]
hikage-extension-betterandroid = { module = "com.highcapable.hikage:hikage-extension-betterandroid", version.ref = "hikage-extension-betterandroid" }
```
在你的项目 `build.gradle.kts` 中配置依赖。
```kotlin
implementation(libs.hikage.extension.betterandroid)
```
请将 `<version>` 修改为此文档顶部显示的版本。
### 传统方式 ### 传统方式
在你的项目 `build.gradle.kts` 中配置依赖。 在你的项目 `build.gradle.kts` 中配置依赖。

View File

@@ -35,6 +35,26 @@ libraries:
implementation(com.highcapable.hikage.hikage.extension.compose) implementation(com.highcapable.hikage.hikage.extension.compose)
``` ```
### Version Catalog
在你的项目 `gradle/libs.versions.toml` 中添加依赖。
```toml
[versions]
hikage-extension-compose = "<version>"
[libraries]
hikage-extension-compose = { module = "com.highcapable.hikage:hikage-extension-compose", version.ref = "hikage-extension-compose" }
```
在你的项目 `build.gradle.kts` 中配置依赖。
```kotlin
implementation(libs.hikage.extension.compose)
```
请将 `<version>` 修改为此文档顶部显示的版本。
### 传统方式 ### 传统方式
在你的项目 `build.gradle.kts` 中配置依赖。 在你的项目 `build.gradle.kts` 中配置依赖。

View File

@@ -29,6 +29,26 @@ libraries:
implementation(com.highcapable.hikage.hikage.extension) implementation(com.highcapable.hikage.hikage.extension)
``` ```
### Version Catalog
在你的项目 `gradle/libs.versions.toml` 中添加依赖。
```toml
[versions]
hikage-extension = "<version>"
[libraries]
hikage-extension = { module = "com.highcapable.hikage:hikage-extension", version.ref = "hikage-extension" }
```
在你的项目 `build.gradle.kts` 中配置依赖。
```kotlin
implementation(libs.hikage.extension)
```
请将 `<version>` 修改为此文档顶部显示的版本。
### 传统方式 ### 传统方式
在你的项目 `build.gradle.kts` 中配置依赖。 在你的项目 `build.gradle.kts` 中配置依赖。

View File

@@ -29,6 +29,26 @@ libraries:
implementation(com.highcapable.hikage.hikage.widget.androidx) implementation(com.highcapable.hikage.hikage.widget.androidx)
``` ```
### Version Catalog
在你的项目 `gradle/libs.versions.toml` 中添加依赖。
```toml
[versions]
hikage-widget-androidx = "<version>"
[libraries]
hikage-widget-androidx = { module = "com.highcapable.hikage:hikage-widget-androidx", version.ref = "hikage-widget-androidx" }
```
在你的项目 `build.gradle.kts` 中配置依赖。
```kotlin
implementation(libs.hikage.widget.androidx)
```
请将 `<version>` 修改为此文档顶部显示的版本。
### 传统方式 ### 传统方式
在你的项目 `build.gradle.kts` 中配置依赖。 在你的项目 `build.gradle.kts` 中配置依赖。

View File

@@ -29,6 +29,26 @@ libraries:
implementation(com.highcapable.hikage.hikage.widget.material) implementation(com.highcapable.hikage.hikage.widget.material)
``` ```
### Version Catalog
在你的项目 `gradle/libs.versions.toml` 中添加依赖。
```toml
[versions]
hikage-widget-material = "<version>"
[libraries]
hikage-widget-material = { module = "com.highcapable.hikage:hikage-widget-material", version.ref = "hikage-widget-material" }
```
在你的项目 `build.gradle.kts` 中配置依赖。
```kotlin
implementation(libs.hikage.widget.material)
```
请将 `<version>` 修改为此文档顶部显示的版本。
### 传统方式 ### 传统方式
在你的项目 `build.gradle.kts` 中配置依赖。 在你的项目 `build.gradle.kts` 中配置依赖。