Skip to content

Commit 6477c9f

Browse files
committed
docs(fix): normalized
1 parent a2eb724 commit 6477c9f

14 files changed

+52
-52
lines changed

docs-source/src/en/about/changelog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
55
::: danger
66

7-
We will only maintain the latest API version, if you are using an outdate API version, you voluntarily renounce any possibility of maintenance.
7+
We will only maintain the latest dependencies. If you are using outdated dependencies, you voluntarily renounce any possibility of maintenance.
88

99
:::
1010

docs-source/src/en/about/contacts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contact Us
22

3-
> If you have any questions in use, or have any constructive suggestions, you can contact us.
3+
> If you have any questions during usage, or have any constructive suggestions, you can contact us.
44
55
Join our developers group.
66

docs-source/src/en/about/future.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
# Looking for Future
1+
# Looking Toward the Future
22

33
> The future is bright and uncertain, let us look forward to the future development space of `Hikage`.
44
55
## Future Plans
66

77
> Features that `Hikage` may add later are included here.
88
9-
### Process AttrtibuteSet
9+
### Process AttributeSet
1010

11-
`Hikage` will support processing `AttributeSet` in the future to dock with the original XML properties to implement the takeover
11+
`Hikage` will support processing `AttributeSet` in the future to interface with the original XML properties to implement the takeover
1212
of some third-party components that are not open to customization of layout properties in the code.
1313

1414
`Hikage` currently supports automated creation of `XmlBlock`, but does not support the direct processing
15-
of customized `AttributeSet`. Because of its historical problems and high processing difficulty, it may compromise whether to continue to improve this function in the later stage.
15+
of customized `AttributeSet`. Because of its historical problems and high processing difficulty, it may be considered whether to continue to improve this function in later stages.
1616

1717
> The following example
1818

docs-source/src/en/config/r8-proguard.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
# R8 & Proguard Obfuscate
1+
# R8 & Proguard Obfuscation
22

3-
> In most scenarios, the app packages can be compressed through obfuscation,
4-
> here is an introduction to how to configure obfuscation rules.
3+
> In most scenarios, app packages can be compressed through obfuscation.
4+
> Here is an introduction to how to configure obfuscation rules.
55
6-
`Hikage` does not require additional configuration of obfuscation rules, since `View` loaded by Hikage does not need to be defined in XML, they can be equally obfuscated.
6+
`Hikage` does not require additional configuration of obfuscation rules, since `View` objects loaded by Hikage do not need to be defined in XML, they can be equally obfuscated.
77

8-
You can force them to be confused with your custom `View`, such as `com.yourpackage.YourView`, using the following rules.
8+
You can force them to be obfuscated with your custom `View`, such as `com.yourpackage.YourView`, using the following rules.
99

1010
```
1111
-allowobfuscation class com.yourpackage.YourView
1212
```
1313

14-
If you must prevent `Hikage` from being confused or something that occurs after being confused, you can use the following rules to prevent `Hikage` from being confused.
14+
If you must prevent `Hikage` from being obfuscated or if something occurs after being obfuscated, you can use the following rules to prevent `Hikage` from being obfuscated.
1515

1616
```
1717
-keep class com.highcapable.hikage**

docs-source/src/en/guide/home.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Introduce
1+
# Introduction
22

33
> `Hikage` (Pronunciation /ˈhɪkɑːɡeɪ/) is an Android responsive UI building tool.
44
55
## Background
66

7-
This is an Android responsive UI build tool designed to focus on **Real-time code building UI**.
7+
This is an Android responsive UI build tool designed to focus on **real-time code-based UI building**.
88

99
The project icon was designed by [MaiTungTM](https://github.com/Lagrio),
1010
the name is taken from the original song "Haru**hikage**" in "BanG Dream It's MyGO!!!!!".
@@ -22,11 +22,11 @@ and its design goal is to enable developers to quickly build UIs and directly su
2222

2323
**<u>Hikage is just a UI build tool and does not provide any UI components themselves</u>**.
2424

25-
Rejecting duplicate wheels, our solution is always compatible and efficient. Now you can abandon ViewBinding and XML and even `findViewById` and try
26-
to use the code layout directly.
25+
Rejecting duplicate wheels, our solution is always compatible and efficient. Now you can abandon ViewBinding and XML, and even `findViewById`, and try
26+
using code layout directly.
2727

28-
`Hikage` works better with another project [BetterAndroid](https://github.com/BetterAndroid/BetterAndroid) and
29-
`Hikage` itself will automatically reference the `BetterAndroid` related dependencies as the core content.
28+
`Hikage` works better with another project [BetterAndroid](https://github.com/BetterAndroid/BetterAndroid), and
29+
`Hikage` itself will automatically reference the `BetterAndroid`-related dependencies as the core content.
3030

3131
## Usage
3232

@@ -116,5 +116,5 @@ The maintenance of this project is inseparable from the support and contribution
116116

117117
This project is currently in its early stages, and there may still be some problems or lack of functions you need.
118118

119-
If possible, feel free to submit a PR to contribute features you think are needed to this project or goto [GitHub Issues](repo://issues)
119+
If possible, feel free to submit a PR to contribute features you think are needed to this project, or go to [GitHub Issues](repo://issues)
120120
to make suggestions to us.

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44
55
## Project Requirements
66

7-
The project needs to be created using `Android Studio` or `IntelliJ IDEA` and be of type Android or Kotlin Multiplatform
8-
project and have integrated Kotlin environment dependencies.
7+
The project needs to be created using `Android Studio` or `IntelliJ IDEA` and must be an Android or Kotlin Multiplatform
8+
project with integrated Kotlin environment dependencies.
99

10-
- Android Studio (It is recommended to get the latest version [from here](https://developer.android.com/studio))
10+
- Android Studio (It is recommended to get the latest version from [here](https://developer.android.com/studio))
1111

12-
- IntelliJ IDEA (It is recommended to get the latest version [from here](https://www.jetbrains.com/idea))
12+
- IntelliJ IDEA (It is recommended to get the latest version from [here](https://www.jetbrains.com/idea))
1313

1414
- Kotlin 1.9.0+, Gradle 8+, Java 17+, Android Gradle Plugin 8+
1515

@@ -38,7 +38,7 @@ repositories:
3838
3939
#### Traditional Method
4040
41-
Configure repositories in your project `build.gradle.kts`.
41+
Configure dependency in your project's `build.gradle.kts`.
4242

4343
```kotlin
4444
repositories {
@@ -53,7 +53,7 @@ repositories {
5353

5454
### Configure Java Version
5555

56-
Modify the Java version of Kotlin in your project `build.gradle.kts` to 17 or above.
56+
Modify the Java version of Kotlin in your project's `build.gradle.kts` to 17 or above.
5757

5858
> Kotlin DSL
5959

@@ -85,5 +85,5 @@ Click the corresponding module below to view detailed feature descriptions.
8585

8686
## Demo
8787

88-
You can find some samples [here](repo://tree/main/samples) view the corresponding demo project to better understand how these functions work and quickly
88+
You can find some samples [here](repo://tree/main/samples) to view the corresponding demo project to better understand how these functions work and quickly
8989
select the functions you need.

docs-source/src/en/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ features:
1414
details: Using View as the foundation and Kotlin as the development language, 100% dynamic code layout, no additional configuration required, supports custom Views.
1515
- title: Fully Compatible
1616
details: Supports embedding and mixing XML, ViewBinding, and Jetpack Compose, and provides support for Material components and Jetpack.
17-
- title: Quickly Started
18-
details: Simple and easy to use it now! Do not need complex configuration and full development experience, Integrate dependencies and enjoy yourself.
17+
- title: Quick to Start
18+
details: Simple and easy to use right now! No complex configuration or extensive development experience needed. Just integrate dependencies and enjoy!
1919
footer: Apache-2.0 License | Copyright (C) 2019 HighCapable
2020
---
2121

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ libraries:
3333
version: +
3434
```
3535
36-
Configure dependency in your root project `build.gradle.kts`.
36+
Configure dependency in your root project's `build.gradle.kts`.
3737

3838
```kotlin
3939
plugins {
@@ -42,7 +42,7 @@ plugins {
4242
}
4343
```
4444

45-
Configure dependency in your project `build.gradle.kts`.
45+
Configure dependency in your project's `build.gradle.kts`.
4646

4747
```kotlin
4848
plugins {
@@ -72,7 +72,7 @@ ksp = { id = "com.google.devtools.ksp", version.ref = "ksp" }
7272
hikage-compiler = { module = "com.highcapable.hikage:hikage-compiler", version.ref = "hikage-compiler" }
7373
```
7474

75-
Configure dependency in your root project `build.gradle.kts`.
75+
Configure dependency in your root project's `build.gradle.kts`.
7676

7777
```kotlin
7878
plugins {
@@ -81,7 +81,7 @@ plugins {
8181
}
8282
```
8383

84-
Configure dependency in your project `build.gradle.kts`.
84+
Configure dependency in your project's `build.gradle.kts`.
8585

8686
```kotlin
8787
plugins {
@@ -109,7 +109,7 @@ plugins {
109109
}
110110
```
111111

112-
Configure dependency in your project `build.gradle.kts`.
112+
Configure dependency in your project's `build.gradle.kts`.
113113

114114
```kotlin
115115
plugins {

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ libraries:
2323
version: +
2424
```
2525
26-
Configure dependency in your project `build.gradle.kts`.
26+
Configure dependency in your project's `build.gradle.kts`.
2727

2828
```kotlin
2929
implementation(com.highcapable.hikage.hikage.core)
@@ -41,7 +41,7 @@ hikage-core = "<version>"
4141
hikage-core = { module = "com.highcapable.hikage:hikage-core", version.ref = "hikage-core" }
4242
```
4343

44-
Configure dependency in your project `build.gradle.kts`.
44+
Configure dependency in your project's `build.gradle.kts`.
4545

4646
```kotlin
4747
implementation(libs.hikage.core)
@@ -51,7 +51,7 @@ Please change `<version>` to the version displayed at the top of this document.
5151

5252
### Traditional Method
5353

54-
Configure dependency in your project `build.gradle.kts`.
54+
Configure dependency in your project's `build.gradle.kts`.
5555

5656
```kotlin
5757
implementation("com.highcapable.hikage:hikage-core:<version>")
@@ -96,7 +96,7 @@ val root = hikage.root
9696
activity.setContentView(root)
9797
```
9898

99-
In this way, we complete a simple layout creation and setting.
99+
In this way, we can complete a simple layout creation and configuration.
100100

101101
### Layout Agreement
102102

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ libraries:
2323
version: +
2424
```
2525
26-
Configure dependency in your project `build.gradle.kts`.
26+
Configure dependency in your project's `build.gradle.kts`.
2727

2828
```kotlin
2929
implementation(com.highcapable.hikage.hikage.extension.betterandroid)
@@ -41,7 +41,7 @@ hikage-extension-betterandroid = "<version>"
4141
hikage-extension-betterandroid = { module = "com.highcapable.hikage:hikage-extension-betterandroid", version.ref = "hikage-extension-betterandroid" }
4242
```
4343

44-
Configure dependency in your project `build.gradle.kts`.
44+
Configure dependency in your project's `build.gradle.kts`.
4545

4646
```kotlin
4747
implementation(libs.hikage.extension.betterandroid)
@@ -51,7 +51,7 @@ Please change `<version>` to the version displayed at the top of this document.
5151

5252
### Traditional Method
5353

54-
Configure dependency in your project `build.gradle.kts`.
54+
Configure dependency in your project's `build.gradle.kts`.
5555

5656
```kotlin
5757
implementation("com.highcapable.hikage:hikage-extension-betterandroid:<version>")

0 commit comments

Comments
 (0)