docs

.editorconfig

@@ -0,0 +1,11 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.{kt, kts}]
+ij_kotlin_imports_layout = *

.github/workflows/build.yml

@@ -1,4 +1,4 @@
-name: Android CI
+name: build
 
 on:
   push:

.github/workflows/docs.yml

@@ -0,0 +1,56 @@
+name: docs
+
+on:
+  push:
+    branches:
+      - master
+
+env:
+  JAVA_VERSION: 11
+  PYTHON_VERSION: 3.x
+  GRADLE_OPTS: "-Dorg.gradle.jvmargs=-Xmx4g -Dorg.gradle.daemon=false -Dkotlin.incremental=false"
+
+permissions:
+  contents: write
+  id-token: write
+  pages: write
+
+jobs:
+  docs:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/master'
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Configure JDK
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'zulu'
+          java-version: ${{ env.JAVA_VERSION }}
+
+      - name: Install Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Install MkDocs Material
+        run: pip install mkdocs-material
+
+      - name: Generate Docs
+        run: ./build_docs.sh
+
+      - name: Upload to GitHub Pages
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: site
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

CHANGELOG.md

@@ -0,0 +1,10 @@
+## 版本日志
+
+#### v1.2.0：2023-7-26
+*  适配Android 11 (R) 软件包的可见性
+
+#### v1.1.0：2023-3-26
+*  迁移发布至 Maven Central
+
+#### v1.0.0：2020-5-3
+*  MapHelper初始版本

README.md

@@ -4,9 +4,7 @@
 
 [![Download](https://img.shields.io/badge/download-App-blue.svg)](https://raw.githubusercontent.com/jenly1314/MapHelper/master/app/release/app-release.apk)
 [![MavenCentral](https://img.shields.io/maven-central/v/com.github.jenly1314/maphelper)](https://repo1.maven.org/maven2/com/github/jenly1314/maphelper/)
-[![JCenter](https://img.shields.io/badge/JCenter-1.0.0-46C018.svg)](https://bintray.com/beta/#/jenly/maven/maphelper)
 [![JitPack](https://jitpack.io/v/jenly1314/MapHelper.svg)](https://jitpack.io/#jenly1314/MapHelper)
-[![CI](https://travis-ci.org/jenly1314/MapHelper.svg?branch=master)](https://travis-ci.org/jenly1314/MapHelper)
 [![CircleCI](https://circleci.com/gh/jenly1314/MapHelper.svg?style=svg)](https://circleci.com/gh/jenly1314/MapHelper)
 [![API](https://img.shields.io/badge/API-16%2B-blue.svg?style=flat)](https://android-arsenal.com/api?level=16)
 [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/mit-license.php)
@@ -64,18 +62,16 @@ MapHelper for Android 是一个整合了高德地图、百度地图、腾讯地
     MapHelper.gcj02ToWGS84(latitude,longitude)
     //...
 ```
-更多使用详情，请查看[app](app)中的源码使用示例或直接查看 [API帮助文档](https://jitpack.io/com/github/jenly1314/MapHelper/latest/javadoc/)
+更多使用详情，请查看[app](app)中的源码使用示例或直接查看 [API帮助文档](https://jenly1314.github.io/MapHelper/api/)
 
-## 版本记录
+<!-- end -->
+
+## 版本日志
 
 #### v1.2.0：2023-7-26
 *  适配Android 11 (R) 软件包的可见性
 
-#### v1.1.0：2023-3-26
-*  迁移发布至 Maven Central
-
-#### v1.0.0：2020-5-3
-*  MapHelper初始版本
+#### [查看更多版本日志](CHANGELOG.md)
 
 ## 赞赏
 如果您喜欢MapHelper，或感觉MapHelper帮助到了您，可以点右上角“Star”支持一下，您的支持就是我的动力，谢谢 :smiley:

app/build.gradle

@@ -26,11 +26,11 @@ android {
         }
     }
     compileOptions {
-        sourceCompatibility JavaVersion.VERSION_11
-        targetCompatibility JavaVersion.VERSION_11
+        sourceCompatibility JavaVersion.VERSION_1_8
+        targetCompatibility JavaVersion.VERSION_1_8
     }
     kotlinOptions {
-        jvmTarget = JavaVersion.VERSION_11
+        jvmTarget = JavaVersion.VERSION_1_8.toString()
     }
     lintOptions {
         abortOnError false

build.gradle

@@ -5,6 +5,6 @@ plugins {
     id 'com.android.application' version '7.2.1' apply false
     id 'com.android.library' version '7.2.1' apply false
     id 'org.jetbrains.kotlin.android' version '1.7.0' apply false
-//    id 'org.jetbrains.dokka' version '1.7.0' apply false
+    id 'org.jetbrains.dokka' version '1.9.20' apply false
     id 'com.vanniktech.maven.publish' version '0.22.0' apply false
-}
+}

build_docs.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+set -ex
+
+# Generate the API docs
+./gradlew dokkaHtml
+
+mkdir -p docs/api
+mv maphelper/build/dokka/html/* docs/api
+
+# Copy in special files that GitHub wants in the project root.
+GITHUB_URL=https://github.com/jenly1314/MapHelper/
+echo $GITHUB_URL
+sed "/<!-- end -->/q" README.md > docs/index.md
+sed -i "s|app/src/main/ic_launcher-playstore.png|ic_logo.png|g" docs/index.md
+sed -i "s|](app|](${GITHUB_URL}blob/master/app|g" docs/index.md
+cat CHANGELOG.md | grep -v '## 版本日志' > docs/changelog.md
+
+cp GIF.gif docs/GIF.gif
+cp app/src/main/ic_launcher-playstore.png docs/ic_logo.png
+
+# Build the site locally
+mkdocs build

maphelper/build.gradle

@@ -1,6 +1,7 @@
 plugins {
     id 'com.android.library'
     id 'org.jetbrains.kotlin.android'
+    id 'org.jetbrains.dokka'
     id 'com.vanniktech.maven.publish'
     id 'kotlin-parcelize'
 }
@@ -23,11 +24,11 @@ android {
         }
     }
     compileOptions {
-        sourceCompatibility JavaVersion.VERSION_11
-        targetCompatibility JavaVersion.VERSION_11
+        sourceCompatibility JavaVersion.VERSION_1_8
+        targetCompatibility JavaVersion.VERSION_1_8
     }
     kotlinOptions {
-        jvmTarget = JavaVersion.VERSION_11
+        jvmTarget = JavaVersion.VERSION_1_8.toString()
     }
     lintOptions {
         abortOnError false
@@ -42,4 +43,4 @@ dependencies {
     androidTestImplementation "androidx.test.ext:junit:$versions.androidExtJunit"
     androidTestImplementation "androidx.test.espresso:espresso-core:$versions.espressoCore"
 
-}
+}

mkdocs.yml

@@ -0,0 +1,86 @@
+# Project information
+site_name: MapHelper
+site_url: https://jenly1314.github.io/MapHelper/
+site_description: "MapHelper for Android"
+site_author: Jenly
+remote_branch: gh-pages
+edit_uri: ""
+
+# Repository
+repo_name: MapHelper
+repo_url: https://github.com/jenly1314/MapHelper
+
+# Copyright
+copyright: 'Copyright © 2016 - 2024 Jenly'
+
+# Configuration
+theme:
+  name: 'material'
+  favicon: https://jenly1314.github.io/favicon.png
+  logo: https://jenly1314.github.io/medias/logo.png
+  icon:
+    repo: fontawesome/brands/github
+  language: zh
+  palette:
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: teal
+      accent: blue
+      toggle:
+        icon: octicons/sun-24
+        name: "切换到深色模式"
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: teal
+      accent: blue
+      toggle:
+        icon: octicons/moon-24
+        name: "切换到浅色模式"
+  features:
+    - navigation.instant
+    - navigation.instant.progress
+    - navigation.tabs
+    - content.code.copy
+
+extra:
+  social:
+    - icon: material/home-circle
+      link: https://jenly1314.github.io/
+    - icon: simple/github
+      link: https://github.com/jenly1314/
+    - icon: simple/gitee
+      link: https://gitee.com/jenly1314/
+    - icon: fontawesome/solid/paper-plane
+      link: mailto:[email protected]
+
+markdown_extensions:
+  - smarty
+  - footnotes
+  - meta
+  - toc:
+      permalink: true
+  - attr_list
+  - pymdownx.betterem:
+      smart_enable: all
+  - pymdownx.caret
+  - pymdownx.emoji:
+      emoji_index: !!python/name:materialx.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg
+  - pymdownx.inlinehilite
+  - pymdownx.magiclink
+  - pymdownx.smartsymbols
+  - pymdownx.superfences
+  - pymdownx.tilde
+  - pymdownx.tabbed:
+      alternate_style: true
+  - tables
+
+# Plugins
+plugins:
+  - search
+
+nav:
+  - '概览': index.md
+  - 'API文档': api/index.html
+  - '版本日志': changelog.md
+