docs: Adapt mkdocs

Author: panpf

.gitignore

@@ -39,4 +39,11 @@ kotlin-js-store/yarn.lock
 webpack.config.d/
 
 .kotlin/
-.run/iosSample.run.xml
+.run/iosSample.run.xml
+
+# docs
+site/
+docs/index.md
+docs/index.zh.md
+docs/CHANGELOG.md
+docs/CHANGELOG.zh.md

CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-Translations: [简体中文](CHANGELOG_zh.md)
+Translations: [简体中文](CHANGELOG.zh.md)
 
 ## 1.1.2
 

CHANGELOG_zh.md CHANGELOG.zh.md

@@ -6,7 +6,7 @@
 [![License][license_image]][license_link]
 [![version_icon]][version_link]
 
-Translations: [简体中文](README_zh.md)
+Translations: [简体中文](README.zh.md)
 
 ZoomImage is an gesture zoom viewing of images library specially designed for Compose Multiplatform
 and Android View. It has the following features and functions:
@@ -48,13 +48,9 @@ https://github.com/panpf/zoomimage/assets/3250512/f067bed9-24e4-4ab8-a839-0731e1
 
 ## Sample App
 
-* Android: Please go to the [Releases](https://github.com/panpf/zoomimage/releases) page to download
-  the latest version of the installation package
-* Web: https://panpf.github.io/zoomimage/app
-* Desktop: Use [kdoctor] to check the running environment, and follow the prompts to install the
-  required software, and then execute the `./package_desktop.sh` command in the project root
-  directory to package. The installation package location is included in the output.
-* iOS: Please refer to the [Run Sample App](#Run-Sample-app) section to compile and run it yourself
+* For Android, iOS, desktop version, and web deployable packages, please go to
+  the [Releases](https://github.com/panpf/zoomimage/releases) page to download.
+* Web example：https://panpf.github.io/zoomimage/app
 
 ## Download
 
@@ -213,17 +209,17 @@ picassoZoomImageView.loadImage("https://sample.com/sample.jpeg")
 
 ## Document
 
-* [Get Started](docs/wiki/getstarted.md)
-* [Scale: Scale the image to see clearer details](docs/wiki/scale.md)
-* [Offset: Move the image to see content outside the container](docs/wiki/offset.md)
-* [Rotate: Rotate the image to view content from different angles](docs/wiki/rotate.md)
-* [Locate: Locate anywhere in the image](docs/wiki/locate.md)
-* [Read Mode: Long images initially fill the screen for easy reading](docs/wiki/readmode.md)
-* [Click: Receive click events](docs/wiki/click.md)
-* [Subsampling: Display large images through subsampling to avoid OOM](docs/wiki/subsampling.md)
-* [Scroll Bar: Displays horizontal and vertical scroll bars](docs/wiki/scrollbar.md)
-* [Log: Modify log level and output pipeline](docs/wiki/log.md)
-* [Modifier.zoom()](docs/wiki/modifier_zoom.md)
+* [Get Started](docs/getting_started.md)
+* [Scale: Scale the image to see clearer details](docs/scale.md)
+* [Offset: Move the image to see content outside the container](docs/offset.md)
+* [Rotate: Rotate the image to view content from different angles](docs/rotate.md)
+* [Locate: Locate anywhere in the image](docs/locate.md)
+* [Read Mode: Long images initially fill the screen for easy reading](docs/readmode.md)
+* [Click: Receive click events](docs/click.md)
+* [Subsampling: Display large images through subsampling to avoid OOM](docs/subsampling.md)
+* [Scroll Bar: Displays horizontal and vertical scroll bars](docs/scrollbar.md)
+* [Log: Modify log level and output pipeline](docs/log.md)
+* [Modifier.zoom()](docs/modifier_zoom.md)
 
 ## Samples
 
@@ -283,7 +279,7 @@ The following are my other open source projects. If you are interested, you can
 
 Apache 2.0. See the [LICENSE](LICENSE.txt) file for details.
 
-[logo_image]: docs/res/logo_mini.png
+[logo_image]: docs/images/logo_mini.png
 
 [platform_image]: https://img.shields.io/badge/Platform-Android-brightgreen.svg
 

README.md

@@ -38,11 +38,9 @@ https://github.com/panpf/zoomimage/assets/3250512/f067bed9-24e4-4ab8-a839-0731e1
 
 ## 示例 App
 
-* Android：请到 [Releases](https://github.com/panpf/zoomimage/releases) 页面下载最新版本的安装包
-* Web：https://panpf.github.io/zoomimage/app
-* 桌面：使用 [kdoctor] 检查运行环境，并按照提示安装需要的软件，然后在项目根目录执行
-  `./package_desktop.sh` 命令打包，安装包位置包含在输出中
-* iOS：请参考 [运行示例 App](#运行示例-app) 部分自行编译运行
+* Android、iOS、桌面版、Web 可部署包请到 [Releases](https://github.com/panpf/zoomimage/releases)
+  页面下载最新版本
+* Web 示例：https://panpf.github.io/zoomimage/app
 
 ## 下载
 
@@ -199,17 +197,17 @@ picassoZoomImageView.loadImage("https://sample.com/sample.jpeg")
 
 ## 文档
 
-* [开始使用](docs/wiki/getstarted_zh.md)
-* [Scale: 缩放图片以查看更清晰的细节](docs/wiki/scale_zh.md)
-* [Offset: 移动图片以查看容器之外的内容](docs/wiki/offset_zh.md)
-* [Rotate: 旋转图片以不同角度查看内容](docs/wiki/rotate_zh.md)
-* [Locate: 定位到图片的任意位置](docs/wiki/locate_zh.md)
-* [Read Mode: 长图初始时充满屏幕方便阅读](docs/wiki/readmode_zh.md)
-* [Click: 接收点击事件](docs/wiki/click_zh.md)
-* [Subsampling: 通过子采样的方式显示大图避免 OOM](docs/wiki/subsampling_zh.md)
-* [Scroll Bar: 显示水平和垂直滚动条](docs/wiki/scrollbar_zh.md)
-* [Log: 修改日志等级以及输出管道](docs/wiki/log_zh.md)
-* [Modifier.zoom()](docs/wiki/modifier_zoom_zh.md)
+* [开始使用](docs/getting_started.zh.md)
+* [Scale: 缩放图片以查看更清晰的细节](docs/scale.zh.md)
+* [Offset: 移动图片以查看容器之外的内容](docs/offset.zh.md)
+* [Rotate: 旋转图片以不同角度查看内容](docs/rotate.zh.md)
+* [Locate: 定位到图片的任意位置](docs/locate.zh.md)
+* [Read Mode: 长图初始时充满屏幕方便阅读](docs/readmode.zh.md)
+* [Click: 接收点击事件](docs/click.zh.md)
+* [Subsampling: 通过子采样的方式显示大图避免 OOM](docs/subsampling.zh.md)
+* [Scroll Bar: 显示水平和垂直滚动条](docs/scrollbar.zh.md)
+* [Log: 修改日志等级以及输出管道](docs/log.zh.md)
+* [Modifier.zoom()](docs/modifier_zoom.zh.md)
 
 ## 示例
 
@@ -218,7 +216,7 @@ picassoZoomImageView.loadImage("https://sample.com/sample.jpeg")
 
 ## 更新日志
 
-请查看 [CHANGELOG](CHANGELOG_zh.md) 文件
+请查看 [CHANGELOG](CHANGELOG.zh) 文件
 
 ## 测试平台
 
@@ -260,7 +258,7 @@ picassoZoomImageView.loadImage("https://sample.com/sample.jpeg")
 
 Apache 2.0. 有关详细信息，请参阅 [LICENSE](LICENSE.txt) 文件.
 
-[logo_image]: docs/res/logo_mini.png
+[logo_image]: docs/images/logo_mini.png
 
 [platform_image]: https://img.shields.io/badge/Platform-Android-brightgreen.svg
 

README_zh.md README.zh.md

@@ -0,0 +1,32 @@
+#!/bin/bash
+
+# Exit immediately if a command exits with a non-zero status.
+set -e
+
+cp README.md docs/index.md
+cp README.zh.md docs/index.zh.md
+cp CHANGELOG.md docs/CHANGELOG.md
+cp CHANGELOG.zh.md docs/CHANGELOG.zh.md
+
+perl -pi -e 's|\(README.zh.md\)|\(index.zh.md\)|g' docs/index.md
+perl -pi -e 's|\(LICENSE.txt\)|\(../LICENSE.txt\)|g' docs/index.md
+perl -pi -e 's|\(docs/|\(|g' docs/index.md
+perl -pi -e 's|]: docs/|]: |g' docs/index.md
+perl -pi -e 's|]: zoomimage-|]: ../zoomimage-|g' docs/index.md
+
+perl -pi -e 's|\(README.md\)|\(index.md\)|g' docs/index.zh.md
+perl -pi -e 's|\(LICENSE.txt\)|\(../LICENSE.txt\)|g' docs/index.zh.md
+perl -pi -e 's|\(docs/|\(|g' docs/index.zh.md
+perl -pi -e 's|]: docs/|]: |g' docs/index.zh.md
+perl -pi -e 's|]: zoomimage-|]: ../zoomimage-|g' docs/index.zh.md
+
+perl -pi -e 's|\(docs/|\(|g' docs/CHANGELOG.md
+perl -pi -e 's|\(docs/|\(|g' docs/CHANGELOG.zh.md
+
+find docs -type f -name "*.md" -exec perl -pi -e 's|]: ../|]: https://github.com/panpf/zoomimage/blob/main/|g' {} +
+find docs -type f -name "*.md" -exec perl -pi -e 's|\(../|\(https://github.com/panpf/zoomimage/blob/main/|g' {} +
+
+mkdocs build
+
+git checkout -- docs
+git clean -f -d docs

build_docs.sh

@@ -1,6 +1,6 @@
 ## Click Events
 
-Translations: [简体中文](click_zh.md)
+Translations: [简体中文](click.zh.md)
 
 > [!TIP]
 > * The following example takes precedence over the Compose version component for demonstration
@@ -45,8 +45,8 @@ sketchZoomImageView.onViewLongPressListener = { view: android.view.View, x: Floa
 }
 ```
 
-[ZoomImageView]: ../../zoomimage-view/src/main/kotlin/com/github/panpf/zoomimage/ZoomImageView.kt
+[ZoomImageView]: ../zoomimage-view/src/main/kotlin/com/github/panpf/zoomimage/ZoomImageView.kt
 
-[ZoomImage]: ../../zoomimage-compose/src/commonMain/kotlin/com/github/panpf/zoomimage/ZoomImage.kt
+[ZoomImage]: ../zoomimage-compose/src/commonMain/kotlin/com/github/panpf/zoomimage/ZoomImage.kt
 
-[ZoomState]: ../../zoomimage-compose/src/commonMain/kotlin/com/github/panpf/zoomimage/compose/ZoomState.kt
+[ZoomState]: ../zoomimage-compose/src/commonMain/kotlin/com/github/panpf/zoomimage/compose/ZoomState.kt

docs/wiki/click.md docs/click.md

@@ -44,8 +44,8 @@ sketchZoomImageView.onViewLongPressListener = { view: android.view.View, x: Floa
 }
 ```
 
-[ZoomImageView]: ../../zoomimage-view/src/main/kotlin/com/github/panpf/zoomimage/ZoomImageView.kt
+[ZoomImageView]: ../zoomimage-view/src/main/kotlin/com/github/panpf/zoomimage/ZoomImageView.kt
 
-[ZoomImage]: ../../zoomimage-compose/src/commonMain/kotlin/com/github/panpf/zoomimage/ZoomImage.kt
+[ZoomImage]: ../zoomimage-compose/src/commonMain/kotlin/com/github/panpf/zoomimage/ZoomImage.kt
 
-[ZoomState]: ../../zoomimage-compose/src/commonMain/kotlin/com/github/panpf/zoomimage/compose/ZoomState.kt
+[ZoomState]: ../zoomimage-compose/src/commonMain/kotlin/com/github/panpf/zoomimage/compose/ZoomState.kt

docs/wiki/click_zh.md docs/click.zh.md

@@ -1,6 +1,6 @@
 ## Get Started
 
-Translations: [简体中文](getstarted_zh.md)
+Translations: [简体中文](getting_started.zh.md)
 
 ## Components
 
@@ -44,7 +44,7 @@ Android view：
 
 > [!TIP]
 > * Different components need to import different dependencies, please refer
-    to [README](../../README.md#download) to import the corresponding dependencies*
+    to [README](../README.md#download) to import the corresponding dependencies*
 > * Components with integrated image loaders can support image and subsampling from any source
     without any additional work
 > * Components that do not integrate an image loader can only display local images and require an
@@ -61,7 +61,7 @@ val zoomState: ZoomState by rememberZoomState()
 LaunchedEffect(zoomState.subsampling) {
     val resUri = Res.getUri("files/huge_world.jpeg")
     val imageSource = ImageSource.fromComposeResource(resUri)
-  zoomState.setSubsamplingImage(imageSource)
+    zoomState.setSubsamplingImage(imageSource)
 }
 ZoomImage(
     painter = painterResource(Res.drawable.huge_world_thumbnail),
@@ -229,41 +229,41 @@ val subsampling: SubsamplingEngine = sketchZoomImageView.subsampling
 * [Log: Modify log level and output pipeline](log.md)
 * [Modifier.zoom()](modifier_zoom.md)
 
-[ZoomImage]: ../../zoomimage-compose/src/commonMain/kotlin/com/github/panpf/zoomimage/ZoomImage.kt
+[ZoomImage]: ../zoomimage-compose/src/commonMain/kotlin/com/github/panpf/zoomimage/ZoomImage.kt
 
-[CoilZoomAsyncImage]: ../../zoomimage-compose-coil3/src/commonMain/kotlin/com/github/panpf/zoomimage/SingletonCoilZoomAsyncImage.kt
+[CoilZoomAsyncImage]: ../zoomimage-compose-coil3/src/commonMain/kotlin/com/github/panpf/zoomimage/SingletonCoilZoomAsyncImage.kt
 
-[GlideZoomAsyncImage]: ../../zoomimage-compose-glide/src/main/kotlin/com/github/panpf/zoomimage/GlideZoomAsyncImage.kt
+[GlideZoomAsyncImage]: ../zoomimage-compose-glide/src/main/kotlin/com/github/panpf/zoomimage/GlideZoomAsyncImage.kt
 
-[SketchZoomAsyncImage]: ../../zoomimage-compose-sketch4/src/commonMain/kotlin/com/github/panpf/zoomimage/SingletonSketchZoomAsyncImage.kt
+[SketchZoomAsyncImage]: ../zoomimage-compose-sketch4/src/commonMain/kotlin/com/github/panpf/zoomimage/SingletonSketchZoomAsyncImage.kt
 
-[ZoomImageSample]: ../../sample/src/commonMain/kotlin/com/github/panpf/zoomimage/sample/ui/examples/BasicZoomImageSample.kt
+[ZoomImageSample]: ../sample/src/commonMain/kotlin/com/github/panpf/zoomimage/sample/ui/examples/BasicZoomImageSample.kt
 
-[CoilZoomAsyncImageSample]: ../../sample/src/commonMain/kotlin/com/github/panpf/zoomimage/sample/ui/examples/CoilZoomAsyncImageSample.common.kt
+[CoilZoomAsyncImageSample]: ../sample/src/commonMain/kotlin/com/github/panpf/zoomimage/sample/ui/examples/CoilZoomAsyncImageSample.common.kt
 
-[GlideZoomAsyncImageSample]: ../../sample/src/androidMain/kotlin/com/github/panpf/zoomimage/sample/ui/examples/GlideZoomAsyncImageSample.kt
+[GlideZoomAsyncImageSample]: ../sample/src/androidMain/kotlin/com/github/panpf/zoomimage/sample/ui/examples/GlideZoomAsyncImageSample.kt
 
-[SketchZoomAsyncImageSample]: ../../sample/src/commonMain/kotlin/com/github/panpf/zoomimage/sample/ui/examples/SketchZoomAsyncImageSample.kt
+[SketchZoomAsyncImageSample]: ../sample/src/commonMain/kotlin/com/github/panpf/zoomimage/sample/ui/examples/SketchZoomAsyncImageSample.kt
 
-[ZoomImageView]: ../../zoomimage-view/src/main/kotlin/com/github/panpf/zoomimage/ZoomImageView.kt
+[ZoomImageView]: ../zoomimage-view/src/main/kotlin/com/github/panpf/zoomimage/ZoomImageView.kt
 
-[CoilZoomImageView]: ../../zoomimage-view-coil3-core/src/main/kotlin/com/github/panpf/zoomimage/CoilZoomImageView.kt
+[CoilZoomImageView]: ../zoomimage-view-coil3-core/src/main/kotlin/com/github/panpf/zoomimage/CoilZoomImageView.kt
 
-[GlideZoomImageView]: ../../zoomimage-view-glide/src/main/kotlin/com/github/panpf/zoomimage/GlideZoomImageView.kt
+[GlideZoomImageView]: ../zoomimage-view-glide/src/main/kotlin/com/github/panpf/zoomimage/GlideZoomImageView.kt
 
-[PicassoZoomImageView]: ../../zoomimage-view-picasso/src/main/kotlin/com/github/panpf/zoomimage/PicassoZoomImageView.kt
+[PicassoZoomImageView]: ../zoomimage-view-picasso/src/main/kotlin/com/github/panpf/zoomimage/PicassoZoomImageView.kt
 
-[SketchZoomImageView]: ../../zoomimage-view-sketch4-core/src/main/kotlin/com/github/panpf/zoomimage/SketchZoomImageView.kt
+[SketchZoomImageView]: ../zoomimage-view-sketch4-core/src/main/kotlin/com/github/panpf/zoomimage/SketchZoomImageView.kt
 
-[ZoomImageViewFragment]: ../../sample/src/androidMain/kotlin/com/github/panpf/zoomimage/sample/ui/examples/BasicZoomImageViewFragment.kt
+[ZoomImageViewFragment]: ../sample/src/androidMain/kotlin/com/github/panpf/zoomimage/sample/ui/examples/BasicZoomImageViewFragment.kt
 
-[CoilZoomImageViewFragment]: ../../sample/src/androidMain/kotlin/com/github/panpf/zoomimage/sample/ui/examples/CoilZoomImageViewFragment.kt
+[CoilZoomImageViewFragment]: ../sample/src/androidMain/kotlin/com/github/panpf/zoomimage/sample/ui/examples/CoilZoomImageViewFragment.kt
 
-[GlideZoomImageViewFragment]: ../../sample/src/androidMain/kotlin/com/github/panpf/zoomimage/sample/ui/examples/GlideZoomImageViewFragment.kt
+[GlideZoomImageViewFragment]: ../sample/src/androidMain/kotlin/com/github/panpf/zoomimage/sample/ui/examples/GlideZoomImageViewFragment.kt
 
-[PicassoZoomImageViewFragment]: ../../sample/src/androidMain/kotlin/com/github/panpf/zoomimage/sample/ui/examples/PicassoZoomImageViewFragment.kt
+[PicassoZoomImageViewFragment]: ../sample/src/androidMain/kotlin/com/github/panpf/zoomimage/sample/ui/examples/PicassoZoomImageViewFragment.kt
 
-[SketchZoomImageViewFragment]: ../../sample/src/androidMain/kotlin/com/github/panpf/zoomimage/sample/ui/examples/SketchZoomImageViewFragment.kt
+[SketchZoomImageViewFragment]: ../sample/src/androidMain/kotlin/com/github/panpf/zoomimage/sample/ui/examples/SketchZoomImageViewFragment.kt
 
 [Sketch]: https://github.com/panpf/sketch
 
@@ -279,16 +279,16 @@ val subsampling: SubsamplingEngine = sketchZoomImageView.subsampling
 
 [Picasso]: https://github.com/square/picasso
 
-[ZoomableState]: ../../zoomimage-compose/src/commonMain/kotlin/com/github/panpf/zoomimage/compose/zoom/ZoomableState.kt
+[ZoomableState]: ../zoomimage-compose/src/commonMain/kotlin/com/github/panpf/zoomimage/compose/zoom/ZoomableState.kt
 
-[SubsamplingState]: ../../zoomimage-compose/src/commonMain/kotlin/com/github/panpf/zoomimage/compose/subsampling/SubsamplingState.kt
+[SubsamplingState]: ../zoomimage-compose/src/commonMain/kotlin/com/github/panpf/zoomimage/compose/subsampling/SubsamplingState.kt
 
-[ZoomableEngine]: ../../zoomimage-view/src/main/kotlin/com/github/panpf/zoomimage/view/zoom/ZoomableEngine.kt
+[ZoomableEngine]: ../zoomimage-view/src/main/kotlin/com/github/panpf/zoomimage/view/zoom/ZoomableEngine.kt
 
-[SubsamplingEngine]: ../../zoomimage-view/src/main/kotlin/com/github/panpf/zoomimage/view/subsampling/SubsamplingEngine.kt
+[SubsamplingEngine]: ../zoomimage-view/src/main/kotlin/com/github/panpf/zoomimage/view/subsampling/SubsamplingEngine.kt
 
-[ZoomImageView]: ../../zoomimage-view/src/main/kotlin/com/github/panpf/zoomimage/ZoomImageView.kt
+[ZoomImageView]: ../zoomimage-view/src/main/kotlin/com/github/panpf/zoomimage/ZoomImageView.kt
 
-[ZoomImage]: ../../zoomimage-compose/src/commonMain/kotlin/com/github/panpf/zoomimage/ZoomImage.kt
+[ZoomImage]: ../zoomimage-compose/src/commonMain/kotlin/com/github/panpf/zoomimage/ZoomImage.kt
 
-[ZoomState]: ../../zoomimage-compose/src/commonMain/kotlin/com/github/panpf/zoomimage/compose/ZoomState.kt
+[ZoomState]: ../zoomimage-compose/src/commonMain/kotlin/com/github/panpf/zoomimage/compose/ZoomState.kt