From 028b287b5530afc8900edd04fba9c7923e49662e Mon Sep 17 00:00:00 2001 From: Jenly Date: Sun, 18 Aug 2024 14:58:34 +0800 Subject: [PATCH] docs --- README.md | 8 ++++---- build_docs.sh | 4 ++++ 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 89852ff..a524e7f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # ZXingLite -![Image](./app/src/main/ic_launcher-web.png) +![Image](app/src/main/ic_launcher-web.png) [![Download](https://img.shields.io/badge/download-App-blue.svg)](https://raw.githubusercontent.com/jenly1314/ZXingLite/master/app/release/app-release.apk) [![MavenCentral](https://img.shields.io/maven-central/v/com.github.jenly1314/zxing-lite)](https://repo1.maven.org/maven2/com/github/jenly1314/zxing-lite) @@ -15,7 +15,7 @@ ZXingLite for Android 是ZXing的精简极速版，基于ZXing库优化扫码和 > 简单如斯，你不试试？ ## Gif 展示 -![Image](./GIF.gif) +![Image](GIF.gif) > 你也可以直接下载 [演示App](https://raw.githubusercontent.com/jenly1314/ZXingLite/master/app/release/app-release.apk) 体验效果 @@ -167,7 +167,7 @@ public class QRCodeScanActivity extends BarcodeCameraScanActivity { > **BarcodeCameraScanFragment** 的使用方式与之类似。 -更多使用详情，请查看[app](./app)中的源码使用示例或直接查看[API帮助文档](https://jenly1314.github.io/ZXingLite/api/) +更多使用详情，请查看[app](app)中的源码使用示例或直接查看[API帮助文档](https://jenly1314.github.io/ZXingLite/api/) ### 其他 @@ -235,7 +235,7 @@ dependencies { * 优化ImageAnalyzer中YUV数据的处理 * 更新CameraX至v1.2.2 -#### [查看更多版本日志](./CHANGELOG.md) +#### [查看更多版本日志](CHANGELOG.md) ## 赞赏 如果您喜欢ZXingLite，或感觉ZXingLite帮助到了您，可以点右上角“Star”支持一下，您的支持就是我的动力，谢谢 :smiley: diff --git a/build_docs.sh b/build_docs.sh index 68a2a3b..2aa9d18 100755 --- a/build_docs.sh +++ b/build_docs.sh @@ -9,7 +9,11 @@ mkdir -p docs/api mv zxing-lite/build/dokka/html/* docs/api # Copy in special files that GitHub wants in the project root. +GITHUB_URL=https://github.com/jenly1314/ZXingLite/ sed '//q' README.md > docs/index.md +sed -i 's|app/src/main/ic_launcher-web.png|($(GITHUB_URL)blob/master/app/src/main/ic_launcher-web.png|g' docs/index.md +sed -i 's|[Image](GIF.gif)|[Image]($(GITHUB_URL)blob/master/GIF.gif)|g' docs/index.md +sed -i 's|[app](app)|[app]($(GITHUB_URL)blob/master/app)|g' docs/index.md cat CHANGELOG.md | grep -v '## 版本日志' > docs/changelog.md # Build the site locally