docs: update document suggestion

This commit is contained in:
2025-11-12 15:09:45 +08:00
parent fe4137ebec
commit bfabdc88c7
6 changed files with 6 additions and 110 deletions

View File

@@ -18,25 +18,7 @@ project with integrated Kotlin environment dependencies.
The dependencies of `KavaRef` 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 repositories in your project's `build.gradle.kts`.

View File

@@ -10,24 +10,7 @@ This is the core dependency of KavaRef, 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.kavaref:
kavaref-core:
version: +
```
Configure dependency in your project's `build.gradle.kts`.
```kotlin
implementation(com.highcapable.kavaref.kavaref.core)
```
### Version Catalog
### Version Catalog (Recommended)
Add dependency in your project's `gradle/libs.versions.toml`.

View File

@@ -10,24 +10,7 @@ This is an extended dependency for KavaRef-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.kavaref:
kavaref-extension:
version: +
```
Configure dependency in your project's `build.gradle.kts`.
```kotlin
implementation(com.highcapable.kavaref.kavaref.extension)
```
### Version Catalog
### Version Catalog (Recommended)
Add dependency in your project's `gradle/libs.versions.toml`.

View File

@@ -16,25 +16,7 @@
`KavaRef` 的依赖发布在 **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` 中配置存储库。

View File

@@ -10,24 +10,7 @@
你可以使用以下方式将此模块添加到你的项目中。
### SweetDependency (推荐)
在你的项目 `SweetDependency` 配置文件中添加依赖。
```yaml
libraries:
com.highcapable.kavaref:
kavaref-core:
version: +
```
在你的项目 `build.gradle.kts` 中配置依赖。
```kotlin
implementation(com.highcapable.kavaref.kavaref.core)
```
### Version Catalog
### Version Catalog (推荐)
在你的项目 `gradle/libs.versions.toml` 中添加依赖。

View File

@@ -10,24 +10,7 @@
你可以使用如下方式将此模块添加到你的项目中。
### SweetDependency (推荐)
在你的项目 `SweetDependency` 配置文件中添加依赖。
```yaml
libraries:
com.highcapable.kavaref:
kavaref-extension:
version: +
```
在你的项目 `build.gradle.kts` 中配置依赖。
```kotlin
implementation(com.highcapable.kavaref.kavaref.extension)
```
### Version Catalog
### Version Catalog (推荐)
在你的项目 `gradle/libs.versions.toml` 中添加依赖。