docs: Improve documents

Author: panpf

.github/workflows/ci.yml

@@ -286,11 +286,11 @@ jobs:
 
             \----------
 
-            更新日志请查看 [CHANGELOG.md](https://github.com/panpf/sketch/blob/main/CHANGELOG_zh.md) 文件
+            更新日志请查看 [CHANGELOG.md](https://github.com/panpf/sketch/blob/main/CHANGELOG.zh.md) 文件
 
             示例 App：
             * Android：Android 平台示例 App 见附件
             * Web：https://panpf.github.io/sketch/app
-            * 其它平台示例 App 请参考文档 [运行示例 App](https://github.com/panpf/sketch/blob/main/README_zh.md#%E8%BF%90%E8%A1%8C%E7%A4%BA%E4%BE%8B-app) 运行源代码体验
+            * 其它平台示例 App 请参考文档 [运行示例 App](https://github.com/panpf/sketch/blob/main/README.zh.md#%E8%BF%90%E8%A1%8C%E7%A4%BA%E4%BE%8B-app) 运行源代码体验
           files: ./downloaded-apks/*.apk
           make_latest: true

CHANGELOG.md

@@ -1,13 +1,13 @@
 # Change Log
 
-Translations: [简体中文](CHANGELOG_zh.md)
+Translations: [简体中文](CHANGELOG.zh.md)
 
 > [!CAUTION]
 > 1. The 4.x version has undergone a lot of destructive reconstruction and simplification to be
      compatible with Compose Multiplatform, and is not compatible with the 3.x version.
 > 2. The maven groupId is upgraded to `io.github.panpf.sketch4`, so versions 2.\* and 3.\* will not
      prompt for upgrade.
-> 3. Reference [《Migration Documentation》](docs/wiki/migrate.md) migrating from 3.x to 4.x
+> 3. Reference [《Migration Documentation》](docs/migrate.md) migrating from 3.x to 4.x
 
 # 4.0.4
 

CHANGELOG_zh.md CHANGELOG.zh.md

@@ -5,7 +5,7 @@
 > [!CAUTION]
 > 1. 4.x 版本为兼容 Compose Multiplatform 而进行了大量破坏性重构和简化，不兼容 3.x 版本
 > 2. maven groupId 升级为 `io.github.panpf.sketch4`，因此 2.\*、3.\* 版本不会提示升级
-> 3. 参考 [《迁移文档》](docs/wiki/migrate_zh.md) 从 3.x 版本迁移 4.x 版本
+> 3. 参考 [《迁移文档》](docs/migrate.zh.md) 从 3.x 版本迁移 4.x 版本
 
 # 4.0.4
 

README.md

@@ -5,7 +5,7 @@
 [![version_icon]][version_link]
 ![QQ Group][qq_group_image]
 
-Translations: [简体中文](README_zh.md)
+Translations: [简体中文](README.zh.md)
 
 Sketch is an image loading library specially designed for Compose Multiplatform and Android View. It
 has the following features:
@@ -360,73 +360,73 @@ Apache 2.0. See the [LICENSE](LICENSE.txt) file for details.
 
 [comment]: <> (wiki)
 
-[animated_image]: docs/wiki/animated_image.md
+[animated_image]: docs/animated_image.md
 
-[apk_app_icon]: docs/wiki/apk_app_icon.md
+[apk_app_icon]: docs/apk_app_icon.md
 
-[compose]: docs/wiki/compose.md
+[compose]: docs/compose.md
 
-[decoder]: docs/wiki/decoder.md
+[decoder]: docs/decoder.md
 
-[download_cache]: docs/wiki/download_cache.md
+[download_cache]: docs/download_cache.md
 
-[exif_orientation]: docs/wiki/exif_orientation.md
+[exif_orientation]: docs/exif_orientation.md
 
-[fetcher]: docs/wiki/fetcher.md
+[fetcher]: docs/fetcher.md
 
-[getting_started]: docs/wiki/getting_started.md
+[getting_started]: docs/getting_started.md
 
-[register_component]: docs/wiki/register_component.md
+[register_component]: docs/register_component.md
 
-[http]: docs/wiki/http.md
+[http]: docs/http.md
 
-[image_options]: docs/wiki/image_options.md
+[image_options]: docs/image_options.md
 
-[lifecycle]: docs/wiki/lifecycle.md
+[lifecycle]: docs/lifecycle.md
 
-[listener]: docs/wiki/listener.md
+[listener]: docs/listener.md
 
-[log]: docs/wiki/log.md
+[log]: docs/log.md
 
-[long_image_grid_thumbnails]: docs/wiki/long_image_grid_thumbnails.md
+[long_image_grid_thumbnails]: docs/long_image_grid_thumbnails.md
 
-[memory_cache]: docs/wiki/memory_cache.md
+[memory_cache]: docs/memory_cache.md
 
-[mime_type_logo]: docs/wiki/mime_type_logo.md
+[mime_type_logo]: docs/mime_type_logo.md
 
-[pause_load_when_scrolling]: docs/wiki/pause_load_when_scrolling.md
+[pause_load_when_scrolling]: docs/pause_load_when_scrolling.md
 
-[preload]: docs/wiki/preload.md
+[preload]: docs/preload.md
 
-[download]: docs/wiki/download_image.md
+[download]: docs/download_image.md
 
-[progress_indicator]: docs/wiki/progress_indicator.md
+[progress_indicator]: docs/progress_indicator.md
 
-[request_interceptor]: docs/wiki/request_interceptor.md
+[request_interceptor]: docs/request_interceptor.md
 
-[decode_interceptor]: docs/wiki/decode_interceptor.md
+[decode_interceptor]: docs/decode_interceptor.md
 
-[resize]: docs/wiki/resize.md
+[resize]: docs/resize.md
 
-[result_cache]: docs/wiki/result_cache.md
+[result_cache]: docs/result_cache.md
 
-[save_cellular_traffic]: docs/wiki/save_cellular_traffic.md
+[save_cellular_traffic]: docs/save_cellular_traffic.md
 
-[sketch_image_view]: docs/wiki/sketch_image_view.md
+[sketch_image_view]: docs/sketch_image_view.md
 
-[state_image]: docs/wiki/state_image.md
+[state_image]: docs/state_image.md
 
-[svg]: docs/wiki/svg.md
+[svg]: docs/svg.md
 
-[target]: docs/wiki/target.md
+[target]: docs/target.md
 
-[transformation]: docs/wiki/transformation.md
+[transformation]: docs/transformation.md
 
-[transition]: docs/wiki/transition.md
+[transition]: docs/transition.md
 
-[video_frame]: docs/wiki/video_frame.md
+[video_frame]: docs/video_frame.md
 
-[migrate]: docs/wiki/migrate.md
+[migrate]: docs/migrate.md
 
 
 [comment]: <> (links)

README_zh.md README.zh.md

@@ -332,73 +332,73 @@ Apache 2.0. 有关详细信息，请参阅 [LICENSE](LICENSE.txt) 文件.
 
 [comment]: <> (wiki)
 
-[animated_image]: docs/wiki/animated_image_zh.md
+[animated_image]: docs/animated_image.zh.md
 
-[apk_app_icon]: docs/wiki/apk_app_icon_zh.md
+[apk_app_icon]: docs/apk_app_icon.zh.md
 
-[compose]: docs/wiki/compose_zh.md
+[compose]: docs/compose.zh.md
 
-[decoder]: docs/wiki/decoder_zh.md
+[decoder]: docs/decoder.zh.md
 
-[download_cache]: docs/wiki/download_cache_zh.md
+[download_cache]: docs/download_cache.zh.md
 
-[exif_orientation]: docs/wiki/exif_orientation_zh.md
+[exif_orientation]: docs/exif_orientation.zh.md
 
-[fetcher]: docs/wiki/fetcher_zh.md
+[fetcher]: docs/fetcher.zh.md
 
-[getting_started]: docs/wiki/getting_started_zh.md
+[getting_started]: docs/getting_started.zh.md
 
-[register_component]: docs/wiki/register_component_zh.md
+[register_component]: docs/register_component.zh.md
 
-[http]: docs/wiki/http_zh.md
+[http]: docs/http.zh.md
 
-[image_options]: docs/wiki/image_options_zh.md
+[image_options]: docs/image_options.zh.md
 
-[lifecycle]: docs/wiki/lifecycle_zh.md
+[lifecycle]: docs/lifecycle.zh.md
 
-[listener]: docs/wiki/listener_zh.md
+[listener]: docs/listener.zh.md
 
-[log]: docs/wiki/log_zh.md
+[log]: docs/log.zh.md
 
-[long_image_grid_thumbnails]: docs/wiki/long_image_grid_thumbnails_zh.md
+[long_image_grid_thumbnails]: docs/long_image_grid_thumbnails.zh.md
 
-[memory_cache]: docs/wiki/memory_cache_zh.md
+[memory_cache]: docs/memory_cache.zh.md
 
-[mime_type_logo]: docs/wiki/mime_type_logo_zh.md
+[mime_type_logo]: docs/mime_type_logo.zh.md
 
-[pause_load_when_scrolling]: docs/wiki/pause_load_when_scrolling_zh.md
+[pause_load_when_scrolling]: docs/pause_load_when_scrolling.zh.md
 
-[preload]: docs/wiki/preload_zh.md
+[preload]: docs/preload.zh.md
 
-[download]: docs/wiki/download_image_zh.md
+[download]: docs/download_image.zh.md
 
-[progress_indicator]: docs/wiki/progress_indicator_zh.md
+[progress_indicator]: docs/progress_indicator.zh.md
 
-[request_interceptor]: docs/wiki/request_interceptor_zh.md
+[request_interceptor]: docs/request_interceptor.zh.md
 
-[decode_interceptor]: docs/wiki/decode_interceptor_zh.md
+[decode_interceptor]: docs/decode_interceptor.zh.md
 
-[resize]: docs/wiki/resize_zh.md
+[resize]: docs/resize.zh.md
 
-[result_cache]: docs/wiki/result_cache_zh.md
+[result_cache]: docs/result_cache.zh.md
 
-[save_cellular_traffic]: docs/wiki/save_cellular_traffic_zh.md
+[save_cellular_traffic]: docs/save_cellular_traffic.zh.md
 
-[sketch_image_view]: docs/wiki/sketch_image_view_zh.md
+[sketch_image_view]: docs/sketch_image_view.zh.md
 
-[state_image]: docs/wiki/state_image_zh.md
+[state_image]: docs/state_image.zh.md
 
-[svg]: docs/wiki/svg_zh.md
+[svg]: docs/svg.zh.md
 
-[target]: docs/wiki/target_zh.md
+[target]: docs/target.zh.md
 
-[transformation]: docs/wiki/transformation_zh.md
+[transformation]: docs/transformation.zh.md
 
-[transition]: docs/wiki/transition_zh.md
+[transition]: docs/transition.zh.md
 
-[video_frame]: docs/wiki/video_frame_zh.md
+[video_frame]: docs/video_frame.zh.md
 
-[migrate]: docs/wiki/migrate_zh.md
+[migrate]: docs/migrate.zh.md
 
 
 [comment]: <> (links)
@@ -427,6 +427,6 @@ Apache 2.0. 有关详细信息，请参阅 [LICENSE](LICENSE.txt) 文件.
 
 [comment]: <> (footer)
 
-[CHANGELOG.md]: CHANGELOG_zh.md
+[CHANGELOG.md]: CHANGELOG.zh.md
 
 [kdoctor]: https://github.com/Kotlin/kdoctor

docs/wiki/animated_image.md docs/animated_image.md

@@ -1,6 +1,6 @@
 # Animated Image
 
-Translations: [简体中文](animated_image_zh.md)
+Translations: [简体中文](animated_image.zh.md)
 
 Sketch provides the `sketch-animated-*` series of modules to support animated graphics. The
 supported platforms and differences are as follows:
@@ -125,45 +125,45 @@ ImageRequest(context, "https://www.example.com/image.gif") {
 
 [version_link]: https://repo1.maven.org/maven2/io/github/panpf/sketch4/
 
-[AnimatableDrawable]: ../../sketch-core/src/androidMain/kotlin/com/github/panpf/sketch/drawable/AnimatableDrawable.kt
+[AnimatableDrawable]: ../sketch-core/src/androidMain/kotlin/com/github/panpf/sketch/drawable/AnimatableDrawable.kt
 
-[AnimatablePainter]: ../../sketch-compose-core/src/commonMain/kotlin/com/github/panpf/sketch/painter/AnimatablePainter.kt
+[AnimatablePainter]: ../sketch-compose-core/src/commonMain/kotlin/com/github/panpf/sketch/painter/AnimatablePainter.kt
 
-[Decoder]: ../../sketch-core/src/commonMain/kotlin/com/github/panpf/sketch/decode/Decoder.kt
+[Decoder]: ../sketch-core/src/commonMain/kotlin/com/github/panpf/sketch/decode/Decoder.kt
 
-[GenericComposeTarget]: ../../sketch-compose-core/src/commonMain/kotlin/com/github/panpf/sketch/target/GenericComposeTarget.kt
+[GenericComposeTarget]: ../sketch-compose-core/src/commonMain/kotlin/com/github/panpf/sketch/target/GenericComposeTarget.kt
 
-[GenericViewTarget]: ../../sketch-view-core/src/main/kotlin/com/github/panpf/sketch/target/GenericViewTarget.kt
+[GenericViewTarget]: ../sketch-view-core/src/main/kotlin/com/github/panpf/sketch/target/GenericViewTarget.kt
 
-[ImageDecoderGifDecoder]: ../../sketch-animated-gif/src/androidMain/kotlin/com/github/panpf/sketch/decode/ImageDecoderGifDecoder.kt
+[ImageDecoderGifDecoder]: ../sketch-animated-gif/src/androidMain/kotlin/com/github/panpf/sketch/decode/ImageDecoderGifDecoder.kt
 
-[KoralGifDecoder]: ../../sketch-animated-gif-koral/src/main/kotlin/com/github/panpf/sketch/decode/KoralGifDecoder.kt
+[KoralGifDecoder]: ../sketch-animated-gif-koral/src/main/kotlin/com/github/panpf/sketch/decode/KoralGifDecoder.kt
 
-[MovieGifDecoder]: ../../sketch-animated-gif/src/androidMain/kotlin/com/github/panpf/sketch/decode/MovieGifDecoder.kt
+[MovieGifDecoder]: ../sketch-animated-gif/src/androidMain/kotlin/com/github/panpf/sketch/decode/MovieGifDecoder.kt
 
-[SkiaGifDecoder]: ../../sketch-animated-gif/src/nonAndroidMain/kotlin/com/github/panpf/sketch/decode/SkiaGifDecoder.kt
+[SkiaGifDecoder]: ../sketch-animated-gif/src/nonAndroidMain/kotlin/com/github/panpf/sketch/decode/SkiaGifDecoder.kt
 
-[ImageDecoderAnimatedHeifDecoder]: ../../sketch-animated-heif/src/main/kotlin/com/github/panpf/sketch/decode/ImageDecoderAnimatedHeifDecoder.kt
+[ImageDecoderAnimatedHeifDecoder]: ../sketch-animated-heif/src/main/kotlin/com/github/panpf/sketch/decode/ImageDecoderAnimatedHeifDecoder.kt
 
-[ImageRequest]: ../../sketch-core/src/commonMain/kotlin/com/github/panpf/sketch/request/ImageRequest.common.kt
+[ImageRequest]: ../sketch-core/src/commonMain/kotlin/com/github/panpf/sketch/request/ImageRequest.common.kt
 
-[ImageOptions]: ../../sketch-core/src/commonMain/kotlin/com/github/panpf/sketch/request/ImageOptions.common.kt
+[ImageOptions]: ../sketch-core/src/commonMain/kotlin/com/github/panpf/sketch/request/ImageOptions.common.kt
 
 [Movie]: https://cs.android.com/android/platform/superproject/+/master:frameworks/base/graphics/java/android/graphics/Movie.java
 
-[ImageDecoderAnimatedWebpDecoder]: ../../sketch-animated-webp/src/androidMain/kotlin/com/github/panpf/sketch/decode/ImageDecoderAnimatedWebpDecoder.kt
+[ImageDecoderAnimatedWebpDecoder]: ../sketch-animated-webp/src/androidMain/kotlin/com/github/panpf/sketch/decode/ImageDecoderAnimatedWebpDecoder.kt
 
-[SkiaAnimatedWebpDecoder]: ../../sketch-animated-webp/src/nonAndroidMain/kotlin/com/github/panpf/sketch/decode/SkiaAnimatedWebpDecoder.kt
+[SkiaAnimatedWebpDecoder]: ../sketch-animated-webp/src/nonAndroidMain/kotlin/com/github/panpf/sketch/decode/SkiaAnimatedWebpDecoder.kt
 
-[GifDecoderProvider]: ../../sketch-animated-gif/src/commonMain/kotlin/com/github/panpf/sketch/decode/internal/GifDecoderProvider.common.kt
+[GifDecoderProvider]: ../sketch-animated-gif/src/commonMain/kotlin/com/github/panpf/sketch/decode/internal/GifDecoderProvider.common.kt
 
-[KoralGifDecoderProvider]: ../../sketch-animated-gif-koral/src/main/kotlin/com/github/panpf/sketch/decode/internal/KoralGifDecoderProvider.kt
+[KoralGifDecoderProvider]: ../sketch-animated-gif-koral/src/main/kotlin/com/github/panpf/sketch/decode/internal/KoralGifDecoderProvider.kt
 
-[AnimatedWebpDecoderProvider]: ../../sketch-animated-webp/src/commonMain/kotlin/com/github/panpf/sketch/decode/internal/AnimatedWebpDecoderProvider.common.kt
+[AnimatedWebpDecoderProvider]: ../sketch-animated-webp/src/commonMain/kotlin/com/github/panpf/sketch/decode/internal/AnimatedWebpDecoderProvider.common.kt
 
-[ImageDecoderAnimatedHeifDecoderProvider]: ../../sketch-animated-heif/src/main/kotlin/com/github/panpf/sketch/decode/internal/ImageDecoderAnimatedHeifDecoderProvider.kt
+[ImageDecoderAnimatedHeifDecoderProvider]: ../sketch-animated-heif/src/main/kotlin/com/github/panpf/sketch/decode/internal/ImageDecoderAnimatedHeifDecoderProvider.kt
 
-[PenfeizhouAnimatedWebpDecoder]: ../../sample/src/androidMain/kotlin/com/github/panpf/sketch/sample/util/PenfeizhouAnimatedWebpDecoder.kt
+[PenfeizhouAnimatedWebpDecoder]: ../sample/src/androidMain/kotlin/com/github/panpf/sketch/sample/util/PenfeizhouAnimatedWebpDecoder.kt
 
 [comment]: <> (wiki)