Skip to content

Commit 1085e78

Browse files
committed
docs: update document suggestion
1 parent 786ba1a commit 1085e78

File tree

2 files changed

+4
-150
lines changed

2 files changed

+4
-150
lines changed

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

Lines changed: 2 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -28,82 +28,9 @@ Use `Android Studio` or `IntelliJ IDEA` to create a new Android project and sele
2828

2929
### Integration Dependencies
3030

31-
We recommend using Kotlin DSL as the Gradle build script language and [SweetDependency](https://github.com/HighCapable/SweetDependency) to manage dependencies.
31+
We recommend using Kotlin DSL as the Gradle build script language.
3232

33-
#### SweetDependency (Recommended)
34-
35-
Add the repositories and dependencies in your project's `SweetDependency` configuration file.
36-
37-
> The following example
38-
39-
```yaml
40-
repositories:
41-
# Must be added when used as an Xposed Module, otherwise optional
42-
rovo89-xposed-api:
43-
url: https://api.xposed.info/
44-
45-
plugins:
46-
# Must be added when used as an Xposed Module, otherwise optional
47-
com.google.devtools.ksp:
48-
version: +
49-
...
50-
51-
libraries:
52-
# Must be added when used as an Xposed Module, otherwise optional
53-
de.robv.android.xposed:
54-
api:
55-
version: 82
56-
repositories:
57-
rovo89-xposed-api
58-
com.highcapable.yukihookapi:
59-
api:
60-
version: +
61-
# Must be added when used as an Xposed Module, otherwise optional
62-
ksp-xposed:
63-
version-ref: <this>::api
64-
# YukiHookAPI version 1.3.0 uses KavaRef as core reflection API
65-
# YukiHookAPI no longer binds its own reflection API, you can start trying to use KavaRef
66-
com.highcapable.kavaref:
67-
kavaref-core:
68-
version: +
69-
kavaref-extension:
70-
version: +
71-
...
72-
```
73-
74-
After adding it, run Gradle Sync and all dependencies will be autowired.
75-
76-
Next, deploy plugins in your project's `build.gradle.kts`.
77-
78-
> The following example
79-
80-
```kotlin
81-
plugins {
82-
// Must be added when used as an Xposed Module, otherwise optional
83-
autowire(libs.plugins.com.google.devtools.ksp)
84-
// ...
85-
}
86-
```
87-
88-
Then, deploy dependencies in your project's `build.gradle.kts`.
89-
90-
> The following example
91-
92-
```kotlin
93-
dependencies {
94-
// Basic dependencies
95-
implementation(com.highcapable.yukihookapi.api)
96-
// It is recommended to use KavaRef as the core reflection API
97-
implementation(com.highcapable.kavaref.kavaref.core)
98-
implementation(com.highcapable.kavaref.kavaref.extension)
99-
// Must be added when used as an Xposed Module, otherwise optional
100-
compileOnly(de.robv.android.xposed.api)
101-
// Must be added when used as an Xposed Module, otherwise optional
102-
ksp(com.highcapable.yukihookapi.ksp.xposed)
103-
}
104-
```
105-
106-
#### Version Catalog
33+
#### Version Catalog (Recommended)
10734

10835
Add repositories in your project's `build.gradle.kts`.
10936

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

Lines changed: 2 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -28,82 +28,9 @@
2828

2929
### 集成依赖
3030

31-
我们推荐使用 Kotlin DSL 作为 Gradle 构建脚本语言并推荐使用 [SweetDependency](https://github.com/HighCapable/SweetDependency) 来管理依赖
31+
我们推荐使用 Kotlin DSL 作为 Gradle 构建脚本语言
3232

33-
#### SweetDependency (推荐)
34-
35-
在你的项目 `SweetDependency` 配置文件中添加存储库和依赖。
36-
37-
> 示例如下
38-
39-
```yaml
40-
repositories:
41-
# 作为 Xposed 模块使用务必添加,其它情况可选
42-
rovo89-xposed-api:
43-
url: https://api.xposed.info/
44-
45-
plugins:
46-
# 作为 Xposed 模块使用务必添加,其它情况可选
47-
com.google.devtools.ksp:
48-
version: +
49-
...
50-
51-
libraries:
52-
# 作为 Xposed 模块使用务必添加,其它情况可选
53-
de.robv.android.xposed:
54-
api:
55-
version: 82
56-
repositories:
57-
rovo89-xposed-api
58-
com.highcapable.yukihookapi:
59-
api:
60-
version: +
61-
# 作为 Xposed 模块使用务必添加,其它情况可选
62-
ksp-xposed:
63-
version-ref: <this>::api
64-
# YukiHookAPI 1.3.0 版本后使用 KavaRef 作为核心反射 API
65-
# YukiHookAPI 不再绑定自身的反射 API,你可以开始尝试使用 KavaRef
66-
com.highcapable.kavaref:
67-
kavaref-core:
68-
version: +
69-
kavaref-extension:
70-
version: +
71-
...
72-
```
73-
74-
添加完成后运行一次 Gradle Sync,所有依赖版本将自动装配。
75-
76-
接下来,在你的项目 `build.gradle.kts` 中部署插件。
77-
78-
> 示例如下
79-
80-
```kotlin
81-
plugins {
82-
// 作为 Xposed 模块使用务必添加,其它情况可选
83-
autowire(libs.plugins.com.google.devtools.ksp)
84-
// ...
85-
}
86-
```
87-
88-
然后,在你的项目 `build.gradle.kts` 中部署依赖。
89-
90-
> 示例如下
91-
92-
```kotlin
93-
dependencies {
94-
// 基础依赖
95-
implementation(com.highcapable.yukihookapi.api)
96-
// 推荐使用 KavaRef 作为核心反射 API
97-
implementation(com.highcapable.kavaref.kavaref.core)
98-
implementation(com.highcapable.kavaref.kavaref.extension)
99-
// 作为 Xposed 模块使用务必添加,其它情况可选
100-
compileOnly(de.robv.android.xposed.api)
101-
// 作为 Xposed 模块使用务必添加,其它情况可选
102-
ksp(com.highcapable.yukihookapi.ksp.xposed)
103-
}
104-
```
105-
106-
#### Version Catalog
33+
#### Version Catalog (推荐)
10734

10835
在你的项目 `build.gradle.kts` 中添加存储库。
10936

0 commit comments

Comments
 (0)