HighCapable/KavaRef
5
0
Fork 0
mirror of https://github.com/HighCapable/KavaRef.git synced 2025-12-10 15:23:50 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: update document suggestion

Browse Source
This commit is contained in:
fankesyooni
2025-11-12 15:09:45 +08:00
parent fe4137ebec
commit bfabdc88c7
6 changed files with 6 additions and 110 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs-source/src/en/guide/quick-start.md
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, The dependencies of `KavaRef` are published in **Maven Central** and our public repository,
you can use the following method to configure repositories. 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) We recommend using Kotlin DSL as the Gradle build script language.
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
Configure repositories in your project's `build.gradle.kts`. Configure repositories in your project's `build.gradle.kts`.

19
docs-source/src/en/library/kavaref-core.md
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. You can add this module to your project using the following method.
### SweetDependency (Recommended) ### Version Catalog (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
Add dependency in your project's `gradle/libs.versions.toml`. Add dependency in your project's `gradle/libs.versions.toml`.

19
docs-source/src/en/library/kavaref-extension.md
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. You can add this module to your project using the following method.
### SweetDependency (Recommended) ### Version Catalog (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
Add dependency in your project's `gradle/libs.versions.toml`. Add dependency in your project's `gradle/libs.versions.toml`.

20
docs-source/src/zh-cn/guide/quick-start.md
View File

@@ -16,25 +16,7 @@
`KavaRef` 的依赖发布在 **Maven Central** 和我们的公共存储库中，你可以使用如下方式配置存储库。 `KavaRef` 的依赖发布在 **Maven Central** 和我们的公共存储库中，你可以使用如下方式配置存储库。
我们推荐使用 Kotlin DSL 作为 Gradle 构建脚本语言并推荐使用 [SweetDependency](https://github.com/HighCapable/SweetDependency) 来管理依赖。 我们推荐使用 Kotlin DSL 作为 Gradle 构建脚本语言。
#### 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
```
#### 传统方式
在你的项目 `build.gradle.kts` 中配置存储库。 在你的项目 `build.gradle.kts` 中配置存储库。

19
docs-source/src/zh-cn/library/kavaref-core.md
View File

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

19
docs-source/src/zh-cn/library/kavaref-extension.md
View File

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