mirror of
https://github.com/BetterAndroid/Hikage.git
synced 2025-12-10 23:53:44 +08:00
docs: update document suggestion
This commit is contained in:
@@ -18,25 +18,7 @@ project with integrated Kotlin environment dependencies.
|
||||
The dependencies of `Hikage` are published in **Maven Central** and our public repository,
|
||||
you can use the following method to configure repositories.
|
||||
|
||||
We recommend using Kotlin DSL as the Gradle build script language and [SweetDependency](https://github.com/HighCapable/SweetDependency)
|
||||
to manage dependencies.
|
||||
|
||||
#### SweetDependency (Recommended)
|
||||
|
||||
Configure repositories in your project's `SweetDependency` configuration file.
|
||||
|
||||
```yaml
|
||||
repositories:
|
||||
google:
|
||||
maven-central:
|
||||
# (Optional) You can add this URL to use our public repository
|
||||
# When Sonatype-OSS fails and cannot publish dependencies, this repository is added as a backup
|
||||
# For details, please visit: https://github.com/HighCapable/maven-repository
|
||||
highcapable-maven-releases:
|
||||
url: https://raw.githubusercontent.com/HighCapable/maven-repository/main/repository/releases
|
||||
```
|
||||
|
||||
#### Traditional Method
|
||||
We recommend using Kotlin DSL as the Gradle build script language.
|
||||
|
||||
Configure dependency in your project's `build.gradle.kts`.
|
||||
|
||||
|
||||
@@ -18,45 +18,7 @@ You need to integrate the [Google KSP](https://github.com/google/ksp/releases) p
|
||||
|
||||
:::
|
||||
|
||||
### SweetDependency (Recommended)
|
||||
|
||||
Add dependency in your project's `SweetDependency` configuration file.
|
||||
|
||||
```yaml
|
||||
plugins:
|
||||
com.google.devtools.ksp:
|
||||
version: +
|
||||
|
||||
libraries:
|
||||
com.highcapable.hikage:
|
||||
hikage-compiler:
|
||||
version: +
|
||||
```
|
||||
|
||||
Configure dependency in your root project's `build.gradle.kts`.
|
||||
|
||||
```kotlin
|
||||
plugins {
|
||||
// ...
|
||||
autowire(libs.plugins.com.google.devtools.ksp) apply false
|
||||
}
|
||||
```
|
||||
|
||||
Configure dependency in your project's `build.gradle.kts`.
|
||||
|
||||
```kotlin
|
||||
plugins {
|
||||
// ...
|
||||
autowire(libs.plugins.com.google.devtools.ksp)
|
||||
}
|
||||
|
||||
dependencies {
|
||||
// ...
|
||||
ksp(com.highcapable.hikage.hikage.compiler)
|
||||
}
|
||||
```
|
||||
|
||||
### Version Catalog
|
||||
### Version Catalog (Recommended)
|
||||
|
||||
Add dependency in your project's `gradle/libs.versions.toml`.
|
||||
|
||||
|
||||
@@ -12,24 +12,7 @@ This is the core dependency of Hikage, and you need to introduce this module to
|
||||
|
||||
You can add this module to your project using the following method.
|
||||
|
||||
### SweetDependency (Recommended)
|
||||
|
||||
Add dependency in your project's `SweetDependency` configuration file.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
com.highcapable.hikage:
|
||||
hikage-core:
|
||||
version: +
|
||||
```
|
||||
|
||||
Configure dependency in your project's `build.gradle.kts`.
|
||||
|
||||
```kotlin
|
||||
implementation(com.highcapable.hikage.hikage.core)
|
||||
```
|
||||
|
||||
### Version Catalog
|
||||
### Version Catalog (Recommended)
|
||||
|
||||
Add dependency in your project's `gradle/libs.versions.toml`.
|
||||
|
||||
|
||||
@@ -12,24 +12,7 @@ This is a Hikage extension dependency for [BetterAndroid](https://github.com/Bet
|
||||
|
||||
You can add this module to your project using the following method.
|
||||
|
||||
### SweetDependency (Recommended)
|
||||
|
||||
Add dependency in your project's `SweetDependency` configuration file.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
com.highcapable.hikage:
|
||||
hikage-extension-betterandroid:
|
||||
version: +
|
||||
```
|
||||
|
||||
Configure dependency in your project's `build.gradle.kts`.
|
||||
|
||||
```kotlin
|
||||
implementation(com.highcapable.hikage.hikage.extension.betterandroid)
|
||||
```
|
||||
|
||||
### Version Catalog
|
||||
### Version Catalog (Recommended)
|
||||
|
||||
Add dependency in your project's `gradle/libs.versions.toml`.
|
||||
|
||||
|
||||
@@ -20,24 +20,7 @@ Please refer to [here](https://developer.android.com/develop/ui/compose/compiler
|
||||
|
||||
:::
|
||||
|
||||
### SweetDependency (Recommended)
|
||||
|
||||
Add dependency in your project's `SweetDependency` configuration file.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
com.highcapable.hikage:
|
||||
hikage-extension-compose:
|
||||
version: +
|
||||
```
|
||||
|
||||
Configure dependency in your project's `build.gradle.kts`.
|
||||
|
||||
```kotlin
|
||||
implementation(com.highcapable.hikage.hikage.extension.compose)
|
||||
```
|
||||
|
||||
### Version Catalog
|
||||
### Version Catalog (Recommended)
|
||||
|
||||
Add dependency in your project's `gradle/libs.versions.toml`.
|
||||
|
||||
|
||||
@@ -12,24 +12,7 @@ This is a Hikage extension dependency for UI component-related features.
|
||||
|
||||
You can add this module to your project using the following method.
|
||||
|
||||
### SweetDependency (Recommended)
|
||||
|
||||
Add dependency in your project's `SweetDependency` configuration file.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
com.highcapable.hikage:
|
||||
hikage-extension:
|
||||
version: +
|
||||
```
|
||||
|
||||
Configure dependency in your project's `build.gradle.kts`.
|
||||
|
||||
```kotlin
|
||||
implementation(com.highcapable.hikage.hikage.extension)
|
||||
```
|
||||
|
||||
### Version Catalog
|
||||
### Version Catalog (Recommended)
|
||||
|
||||
Add dependency in your project's `gradle/libs.versions.toml`.
|
||||
|
||||
|
||||
@@ -12,24 +12,7 @@ This is a Hikage extension dependency for Jetpack Compact component-related feat
|
||||
|
||||
You can add this module to your project using the following method.
|
||||
|
||||
### SweetDependency (Recommended)
|
||||
|
||||
Add dependency in your project's `SweetDependency` configuration file.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
com.highcapable.hikage:
|
||||
hikage-widget-androidx:
|
||||
version: +
|
||||
```
|
||||
|
||||
Configure dependency in your project's `build.gradle.kts`.
|
||||
|
||||
```kotlin
|
||||
implementation(com.highcapable.hikage.hikage.widget.androidx)
|
||||
```
|
||||
|
||||
### Version Catalog
|
||||
### Version Catalog (Recommended)
|
||||
|
||||
Add dependency in your project's `gradle/libs.versions.toml`.
|
||||
|
||||
|
||||
@@ -12,24 +12,7 @@ This is a Hikage extension dependency for Google Material (MDC) component-relate
|
||||
|
||||
You can add this module to your project using the following method.
|
||||
|
||||
### SweetDependency (Recommended)
|
||||
|
||||
Add dependency in your project's `SweetDependency` configuration file.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
com.highcapable.hikage:
|
||||
hikage-widget-material:
|
||||
version: +
|
||||
```
|
||||
|
||||
Configure dependency in your project's `build.gradle.kts`.
|
||||
|
||||
```kotlin
|
||||
implementation(com.highcapable.hikage.hikage.widget.material)
|
||||
```
|
||||
|
||||
### Version Catalog
|
||||
### Version Catalog (Recommended)
|
||||
|
||||
Add dependency in your project's `gradle/libs.versions.toml`.
|
||||
|
||||
|
||||
@@ -16,25 +16,7 @@
|
||||
|
||||
`Hikage` 的依赖发布在 **Maven Central** 和我们的公共存储库中,你可以使用如下方式配置存储库。
|
||||
|
||||
我们推荐使用 Kotlin DSL 作为 Gradle 构建脚本语言并推荐使用 [SweetDependency](https://github.com/HighCapable/SweetDependency) 来管理依赖。
|
||||
|
||||
#### SweetDependency (推荐)
|
||||
|
||||
在你的项目 `SweetDependency` 配置文件中配置存储库。
|
||||
|
||||
```yaml
|
||||
repositories:
|
||||
google:
|
||||
maven-central:
|
||||
# (可选) 你可以添加此 URL 以使用我们的公共存储库
|
||||
# 当 Sonatype-OSS 发生故障无法发布依赖时,此存储库作为备选进行添加
|
||||
# 详情请前往:https://github.com/HighCapable/maven-repository
|
||||
highcapable-maven-releases:
|
||||
# 中国大陆用户请将下方的 "raw.githubusercontent.com" 修改为 "raw.gitmirror.com"
|
||||
url: https://raw.githubusercontent.com/HighCapable/maven-repository/main/repository/releases
|
||||
```
|
||||
|
||||
#### 传统方式
|
||||
我们推荐使用 Kotlin DSL 作为 Gradle 构建脚本语言。
|
||||
|
||||
在你的项目 `build.gradle.kts` 中配置存储库。
|
||||
|
||||
|
||||
@@ -18,45 +18,7 @@
|
||||
|
||||
:::
|
||||
|
||||
### SweetDependency (推荐)
|
||||
|
||||
在你的项目 `SweetDependency` 配置文件中添加依赖。
|
||||
|
||||
```yaml
|
||||
plugins:
|
||||
com.google.devtools.ksp:
|
||||
version: +
|
||||
|
||||
libraries:
|
||||
com.highcapable.hikage:
|
||||
hikage-compiler:
|
||||
version: +
|
||||
```
|
||||
|
||||
在你的根项目 `build.gradle.kts` 中配置依赖。
|
||||
|
||||
```kotlin
|
||||
plugins {
|
||||
// ...
|
||||
autowire(libs.plugins.com.google.devtools.ksp) apply false
|
||||
}
|
||||
```
|
||||
|
||||
在你的项目 `build.gradle.kts` 中配置依赖。
|
||||
|
||||
```kotlin
|
||||
plugins {
|
||||
// ...
|
||||
autowire(libs.plugins.com.google.devtools.ksp)
|
||||
}
|
||||
|
||||
dependencies {
|
||||
// ...
|
||||
ksp(com.highcapable.hikage.hikage.compiler)
|
||||
}
|
||||
```
|
||||
|
||||
### Version Catalog
|
||||
### Version Catalog (推荐)
|
||||
|
||||
在你的项目 `gradle/libs.versions.toml` 中添加依赖。
|
||||
|
||||
|
||||
@@ -12,24 +12,7 @@
|
||||
|
||||
你可以使用如下方式将此模块添加到你的项目中。
|
||||
|
||||
### SweetDependency (推荐)
|
||||
|
||||
在你的项目 `SweetDependency` 配置文件中添加依赖。
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
com.highcapable.hikage:
|
||||
hikage-core:
|
||||
version: +
|
||||
```
|
||||
|
||||
在你的项目 `build.gradle.kts` 中配置依赖。
|
||||
|
||||
```kotlin
|
||||
implementation(com.highcapable.hikage.hikage.core)
|
||||
```
|
||||
|
||||
### Version Catalog
|
||||
### Version Catalog (推荐)
|
||||
|
||||
在你的项目 `gradle/libs.versions.toml` 中添加依赖。
|
||||
|
||||
|
||||
@@ -12,24 +12,7 @@
|
||||
|
||||
你可以使用如下方式将此模块添加到你的项目中。
|
||||
|
||||
### SweetDependency (推荐)
|
||||
|
||||
在你的项目 `SweetDependency` 配置文件中添加依赖。
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
com.highcapable.hikage:
|
||||
hikage-extension-betterandroid:
|
||||
version: +
|
||||
```
|
||||
|
||||
在你的项目 `build.gradle.kts` 中配置依赖。
|
||||
|
||||
```kotlin
|
||||
implementation(com.highcapable.hikage.hikage.extension.betterandroid)
|
||||
```
|
||||
|
||||
### Version Catalog
|
||||
### Version Catalog (推荐)
|
||||
|
||||
在你的项目 `gradle/libs.versions.toml` 中添加依赖。
|
||||
|
||||
|
||||
@@ -18,24 +18,7 @@
|
||||
|
||||
:::
|
||||
|
||||
### SweetDependency (推荐)
|
||||
|
||||
在你的项目 `SweetDependency` 配置文件中添加依赖。
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
com.highcapable.hikage:
|
||||
hikage-extension-compose:
|
||||
version: +
|
||||
```
|
||||
|
||||
在你的项目 `build.gradle.kts` 中配置依赖。
|
||||
|
||||
```kotlin
|
||||
implementation(com.highcapable.hikage.hikage.extension.compose)
|
||||
```
|
||||
|
||||
### Version Catalog
|
||||
### Version Catalog (推荐)
|
||||
|
||||
在你的项目 `gradle/libs.versions.toml` 中添加依赖。
|
||||
|
||||
|
||||
@@ -12,24 +12,7 @@
|
||||
|
||||
你可以使用如下方式将此模块添加到你的项目中。
|
||||
|
||||
### SweetDependency (推荐)
|
||||
|
||||
在你的项目 `SweetDependency` 配置文件中添加依赖。
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
com.highcapable.hikage:
|
||||
hikage-extension:
|
||||
version: +
|
||||
```
|
||||
|
||||
在你的项目 `build.gradle.kts` 中配置依赖。
|
||||
|
||||
```kotlin
|
||||
implementation(com.highcapable.hikage.hikage.extension)
|
||||
```
|
||||
|
||||
### Version Catalog
|
||||
### Version Catalog (推荐)
|
||||
|
||||
在你的项目 `gradle/libs.versions.toml` 中添加依赖。
|
||||
|
||||
|
||||
@@ -12,24 +12,7 @@
|
||||
|
||||
你可以使用如下方式将此模块添加到你的项目中。
|
||||
|
||||
### SweetDependency (推荐)
|
||||
|
||||
在你的项目 `SweetDependency` 配置文件中添加依赖。
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
com.highcapable.hikage:
|
||||
hikage-widget-androidx:
|
||||
version: +
|
||||
```
|
||||
|
||||
在你的项目 `build.gradle.kts` 中配置依赖。
|
||||
|
||||
```kotlin
|
||||
implementation(com.highcapable.hikage.hikage.widget.androidx)
|
||||
```
|
||||
|
||||
### Version Catalog
|
||||
### Version Catalog (推荐)
|
||||
|
||||
在你的项目 `gradle/libs.versions.toml` 中添加依赖。
|
||||
|
||||
|
||||
@@ -12,24 +12,7 @@
|
||||
|
||||
你可以使用如下方式将此模块添加到你的项目中。
|
||||
|
||||
### SweetDependency (推荐)
|
||||
|
||||
在你的项目 `SweetDependency` 配置文件中添加依赖。
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
com.highcapable.hikage:
|
||||
hikage-widget-material:
|
||||
version: +
|
||||
```
|
||||
|
||||
在你的项目 `build.gradle.kts` 中配置依赖。
|
||||
|
||||
```kotlin
|
||||
implementation(com.highcapable.hikage.hikage.widget.material)
|
||||
```
|
||||
|
||||
### Version Catalog
|
||||
### Version Catalog (推荐)
|
||||
|
||||
在你的项目 `gradle/libs.versions.toml` 中添加依赖。
|
||||
|
||||
|
||||
Reference in New Issue
Block a user