docs

Author: jenly1314

.circleci/config.yml

@@ -5,9 +5,10 @@ orbs:
 
 jobs:
   build:
-    executor: android/android
-
+    docker:
+      - image: cimg/android:2023.02
     steps:
       - checkout
       - run:
-          command: ./gradlew build
+          command: ./gradlew build
+

.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/gradle.yml .github/workflows/build.yml.github/workflows/gradle.yml renamed to .github/workflows/build.yml

@@ -1,4 +1,4 @@
-name: Android CI
+name: build
 
 on:
   push:
@@ -17,4 +17,4 @@ jobs:
         with:
           java-version: 11
       - name: Build with Gradle
-        run: ./gradlew build
+        run: ./gradlew build

.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,4 @@
+## 版本日志
+
+#### v1.0.0：2022-11-20
+*  CodeTextField初始版本

README.md

@@ -50,15 +50,17 @@ CodeTextField for Jetpack Compose；一个使用 Compose 实现的验证码输
 
 ```
 
-更多使用详情，请查看[app](app)中的源码使用示例或直接查看 [API帮助文档](https://jitpack.io/com/github/jenly1314/CodeTextField/latest/javadoc/)
+更多使用详情，请查看[app](app)中的源码使用示例或直接查看 [API帮助文档](https://jenly1314.github.io/CodeTextField/api/)
 
 ## 相关推荐
 
 #### [SplitEditText](https://github.com/jenly1314/SplitEditText) 一个灵活的分割可编辑框；常常应用于 **验证码输入** 、**密码输入** 等场景。
 #### [KingKeyboard](https://github.com/jenly1314/KingKeyboard) 一个自定义键盘，满足各种不同场景的键盘输入需求。
 #### [compose-component](https://github.com/jenly1314/compose-component) 一个Jetpack Compose的组件库；主要提供了一些小组件，便于快速使用。
 
-## 版本记录
+<!-- end -->
+
+## 版本日志
 
 #### v1.0.0：2022-11-20
 *  CodeTextField初始版本

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
     }
     buildFeatures {
         compose true
@@ -63,4 +63,4 @@ dependencies {
     androidTestImplementation "androidx.test.espresso:espresso-core:$versions.espressoCore"
 
     implementation project(":codetextfield")
-}
+}

app/src/main/java/com/king/compose/codetextfield/app/MainActivity.kt

@@ -13,7 +13,6 @@ import androidx.compose.runtime.mutableStateOf
 import androidx.compose.runtime.remember
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.graphics.Color
-import androidx.compose.ui.graphics.RectangleShape
 import androidx.compose.ui.graphics.SolidColor
 import androidx.compose.ui.res.stringResource
 import androidx.compose.ui.text.TextStyle

build.gradle

@@ -5,10 +5,10 @@ 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.8.20' apply false
     id 'com.vanniktech.maven.publish' version '0.22.0' apply false
 }
 
 //task clean(type: Delete) {
 //    delete rootProject.buildDir
-//}
+//}

build_docs.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+set -ex
+
+# Generate the API docs
+./gradlew dokkaHtml
+
+mkdir -p docs/api
+mv codetextfield/build/dokka/html/* docs/api
+
+# Copy in special files that GitHub wants in the project root.
+GITHUB_URL=https://github.com/jenly1314/CodeTextField/
+echo $GITHUB_URL
+sed "/<!-- end -->/q" README.md > docs/index.md
+# sed -i "s|app/src/main/ic_launcher-web.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-web.png docs/ic_logo.png
+
+# Build the site locally
+mkdocs build