Skip to content

Commit e4923b6

Browse files
committed
docs: update document suggestion
1 parent cea0701 commit e4923b6

16 files changed

+16
-332
lines changed

docs-source/src/en/guide/quick-start.md

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -18,25 +18,7 @@ project with integrated Kotlin environment dependencies.
1818
The dependencies of `Hikage` are published in **Maven Central** and our public repository,
1919
you can use the following method to configure repositories.
2020

21-
We recommend using Kotlin DSL as the Gradle build script language and [SweetDependency](https://github.com/HighCapable/SweetDependency)
22-
to manage dependencies.
23-
24-
#### SweetDependency (Recommended)
25-
26-
Configure repositories in your project's `SweetDependency` configuration file.
27-
28-
```yaml
29-
repositories:
30-
google:
31-
maven-central:
32-
# (Optional) You can add this URL to use our public repository
33-
# When Sonatype-OSS fails and cannot publish dependencies, this repository is added as a backup
34-
# For details, please visit: https://github.com/HighCapable/maven-repository
35-
highcapable-maven-releases:
36-
url: https://raw.githubusercontent.com/HighCapable/maven-repository/main/repository/releases
37-
```
38-
39-
#### Traditional Method
21+
We recommend using Kotlin DSL as the Gradle build script language.
4022

4123
Configure dependency in your project's `build.gradle.kts`.
4224

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

Lines changed: 1 addition & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -18,45 +18,7 @@ You need to integrate the [Google KSP](https://github.com/google/ksp/releases) p
1818

1919
:::
2020

21-
### SweetDependency (Recommended)
22-
23-
Add dependency in your project's `SweetDependency` configuration file.
24-
25-
```yaml
26-
plugins:
27-
com.google.devtools.ksp:
28-
version: +
29-
30-
libraries:
31-
com.highcapable.hikage:
32-
hikage-compiler:
33-
version: +
34-
```
35-
36-
Configure dependency in your root project's `build.gradle.kts`.
37-
38-
```kotlin
39-
plugins {
40-
// ...
41-
autowire(libs.plugins.com.google.devtools.ksp) apply false
42-
}
43-
```
44-
45-
Configure dependency in your project's `build.gradle.kts`.
46-
47-
```kotlin
48-
plugins {
49-
// ...
50-
autowire(libs.plugins.com.google.devtools.ksp)
51-
}
52-
53-
dependencies {
54-
// ...
55-
ksp(com.highcapable.hikage.hikage.compiler)
56-
}
57-
```
58-
59-
### Version Catalog
21+
### Version Catalog (Recommended)
6022

6123
Add dependency in your project's `gradle/libs.versions.toml`.
6224

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

Lines changed: 1 addition & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,7 @@ This is the core dependency of Hikage, and you need to introduce this module to
1212

1313
You can add this module to your project using the following method.
1414

15-
### SweetDependency (Recommended)
16-
17-
Add dependency in your project's `SweetDependency` configuration file.
18-
19-
```yaml
20-
libraries:
21-
com.highcapable.hikage:
22-
hikage-core:
23-
version: +
24-
```
25-
26-
Configure dependency in your project's `build.gradle.kts`.
27-
28-
```kotlin
29-
implementation(com.highcapable.hikage.hikage.core)
30-
```
31-
32-
### Version Catalog
15+
### Version Catalog (Recommended)
3316

3417
Add dependency in your project's `gradle/libs.versions.toml`.
3518

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

Lines changed: 1 addition & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,7 @@ This is a Hikage extension dependency for [BetterAndroid](https://github.com/Bet
1212

1313
You can add this module to your project using the following method.
1414

15-
### SweetDependency (Recommended)
16-
17-
Add dependency in your project's `SweetDependency` configuration file.
18-
19-
```yaml
20-
libraries:
21-
com.highcapable.hikage:
22-
hikage-extension-betterandroid:
23-
version: +
24-
```
25-
26-
Configure dependency in your project's `build.gradle.kts`.
27-
28-
```kotlin
29-
implementation(com.highcapable.hikage.hikage.extension.betterandroid)
30-
```
31-
32-
### Version Catalog
15+
### Version Catalog (Recommended)
3316

3417
Add dependency in your project's `gradle/libs.versions.toml`.
3518

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

Lines changed: 1 addition & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -20,24 +20,7 @@ Please refer to [here](https://developer.android.com/develop/ui/compose/compiler
2020

2121
:::
2222

23-
### SweetDependency (Recommended)
24-
25-
Add dependency in your project's `SweetDependency` configuration file.
26-
27-
```yaml
28-
libraries:
29-
com.highcapable.hikage:
30-
hikage-extension-compose:
31-
version: +
32-
```
33-
34-
Configure dependency in your project's `build.gradle.kts`.
35-
36-
```kotlin
37-
implementation(com.highcapable.hikage.hikage.extension.compose)
38-
```
39-
40-
### Version Catalog
23+
### Version Catalog (Recommended)
4124

4225
Add dependency in your project's `gradle/libs.versions.toml`.
4326

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

Lines changed: 1 addition & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,7 @@ This is a Hikage extension dependency for UI component-related features.
1212

1313
You can add this module to your project using the following method.
1414

15-
### SweetDependency (Recommended)
16-
17-
Add dependency in your project's `SweetDependency` configuration file.
18-
19-
```yaml
20-
libraries:
21-
com.highcapable.hikage:
22-
hikage-extension:
23-
version: +
24-
```
25-
26-
Configure dependency in your project's `build.gradle.kts`.
27-
28-
```kotlin
29-
implementation(com.highcapable.hikage.hikage.extension)
30-
```
31-
32-
### Version Catalog
15+
### Version Catalog (Recommended)
3316

3417
Add dependency in your project's `gradle/libs.versions.toml`.
3518

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

Lines changed: 1 addition & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,7 @@ This is a Hikage extension dependency for Jetpack Compact component-related feat
1212

1313
You can add this module to your project using the following method.
1414

15-
### SweetDependency (Recommended)
16-
17-
Add dependency in your project's `SweetDependency` configuration file.
18-
19-
```yaml
20-
libraries:
21-
com.highcapable.hikage:
22-
hikage-widget-androidx:
23-
version: +
24-
```
25-
26-
Configure dependency in your project's `build.gradle.kts`.
27-
28-
```kotlin
29-
implementation(com.highcapable.hikage.hikage.widget.androidx)
30-
```
31-
32-
### Version Catalog
15+
### Version Catalog (Recommended)
3316

3417
Add dependency in your project's `gradle/libs.versions.toml`.
3518

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

Lines changed: 1 addition & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,7 @@ This is a Hikage extension dependency for Google Material (MDC) component-relate
1212

1313
You can add this module to your project using the following method.
1414

15-
### SweetDependency (Recommended)
16-
17-
Add dependency in your project's `SweetDependency` configuration file.
18-
19-
```yaml
20-
libraries:
21-
com.highcapable.hikage:
22-
hikage-widget-material:
23-
version: +
24-
```
25-
26-
Configure dependency in your project's `build.gradle.kts`.
27-
28-
```kotlin
29-
implementation(com.highcapable.hikage.hikage.widget.material)
30-
```
31-
32-
### Version Catalog
15+
### Version Catalog (Recommended)
3316

3417
Add dependency in your project's `gradle/libs.versions.toml`.
3518

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

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -16,25 +16,7 @@
1616

1717
`Hikage` 的依赖发布在 **Maven Central** 和我们的公共存储库中,你可以使用如下方式配置存储库。
1818

19-
我们推荐使用 Kotlin DSL 作为 Gradle 构建脚本语言并推荐使用 [SweetDependency](https://github.com/HighCapable/SweetDependency) 来管理依赖。
20-
21-
#### SweetDependency (推荐)
22-
23-
在你的项目 `SweetDependency` 配置文件中配置存储库。
24-
25-
```yaml
26-
repositories:
27-
google:
28-
maven-central:
29-
# (可选) 你可以添加此 URL 以使用我们的公共存储库
30-
# 当 Sonatype-OSS 发生故障无法发布依赖时,此存储库作为备选进行添加
31-
# 详情请前往:https://github.com/HighCapable/maven-repository
32-
highcapable-maven-releases:
33-
# 中国大陆用户请将下方的 "raw.githubusercontent.com" 修改为 "raw.gitmirror.com"
34-
url: https://raw.githubusercontent.com/HighCapable/maven-repository/main/repository/releases
35-
```
36-
37-
#### 传统方式
19+
我们推荐使用 Kotlin DSL 作为 Gradle 构建脚本语言。
3820

3921
在你的项目 `build.gradle.kts` 中配置存储库。
4022

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

Lines changed: 1 addition & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -18,45 +18,7 @@
1818

1919
:::
2020

21-
### SweetDependency (推荐)
22-
23-
在你的项目 `SweetDependency` 配置文件中添加依赖。
24-
25-
```yaml
26-
plugins:
27-
com.google.devtools.ksp:
28-
version: +
29-
30-
libraries:
31-
com.highcapable.hikage:
32-
hikage-compiler:
33-
version: +
34-
```
35-
36-
在你的根项目 `build.gradle.kts` 中配置依赖。
37-
38-
```kotlin
39-
plugins {
40-
// ...
41-
autowire(libs.plugins.com.google.devtools.ksp) apply false
42-
}
43-
```
44-
45-
在你的项目 `build.gradle.kts` 中配置依赖。
46-
47-
```kotlin
48-
plugins {
49-
// ...
50-
autowire(libs.plugins.com.google.devtools.ksp)
51-
}
52-
53-
dependencies {
54-
// ...
55-
ksp(com.highcapable.hikage.hikage.compiler)
56-
}
57-
```
58-
59-
### Version Catalog
21+
### Version Catalog (推荐)
6022

6123
在你的项目 `gradle/libs.versions.toml` 中添加依赖。
6224

0 commit comments

Comments
 (0)