Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jenly1314 committed Aug 26, 2024
1 parent 273ae4d commit c638d15
Show file tree
Hide file tree
Showing 7 changed files with 218 additions and 12 deletions.
11 changes: 11 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -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 = *
20 changes: 14 additions & 6 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -1,20 +1,28 @@
name: Android CI
name: build

on:
push:
branches: [ master ]
pull_request:
branches: [ master ]

env:
JAVA_VERSION: 11

jobs:
build:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- name: Set up JDK 11
uses: actions/setup-java@v1
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Configure JDK
uses: actions/setup-java@v4
with:
java-version: 11
distribution: 'zulu'
java-version: ${{ env.JAVA_VERSION }}
- name: Build with Gradle
run: ./gradlew build
run: ./gradlew build
56 changes: 56 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -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
22 changes: 22 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
## 版本日志

#### v1.1.1:2024-7-17
* 优化细节

#### v1.1.0:2024-6-25
* 新增自定义属性`arcThumbDrawable`
* 优化细节

#### v1.0.3:2021-9-1 (从v1.0.3开始发布至 MavenCentral)
* 对外暴露更多getter和setter方法
* 新增arcTickOffsetAngle属性
* 发布至 **MavenCentral**

#### v1.0.2:2020-12-2
* 优化设置渐变色过程处理

#### v1.0.1:2020-9-16
* 优化细节

#### v1.0.0:2020-3-28
* ArcSeekBar初始版本
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,18 @@
# ArcSeekBar

[![Download](https://img.shields.io/badge/download-App-blue.svg)](https://raw.githubusercontent.com/jenly1314/ArcSeekBar/master/app/release/app-release.apk)
[![JCenter](https://img.shields.io/badge/JCenter-1.0.2-46C018.svg)](https://bintray.com/beta/#/jenly/maven/arcseekbar)
[![MavenCentral](https://img.shields.io/maven-central/v/com.github.jenly1314/arcseekbar)](https://repo1.maven.org/maven2/com/github/jenly1314/arcseekbar)
[![JitPack](https://jitpack.io/v/jenly1314/ArcSeekBar.svg)](https://jitpack.io/#jenly1314/ArcSeekBar)
[![CI](https://travis-ci.org/jenly1314/ArcSeekBar.svg?branch=master)](https://travis-ci.org/jenly1314/ArcSeekBar)
[![CircleCI](https://circleci.com/gh/jenly1314/ArcSeekBar.svg?style=svg)](https://circleci.com/gh/jenly1314/ArcSeekBar)
[![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)

ArcSeekBar for Android 是一个弧形的拖动条进度控件,配置参数完全可定制化。

**ArcSeekBar** 是基于 [CircleProgressView](https://github.com/jenly1314/CircleProgressView) 修改而来的库。
但青出于蓝而胜于蓝,所以 [CircleProgressView](https://github.com/jenly1314/CircleProgressView) 的大部分用法,**ArcSeekBar**基本都支持,而且可配置的参数更细致。
但青出于蓝而胜于蓝,所以 [CircleProgressView](https://github.com/jenly1314/CircleProgressView) 的大部分用法,**ArcSeekBar** 基本都支持,而且可配置的参数更细致。

之所以新造一个ArcSeekBar库,而不直接在**CircleProgressView**上面直接改,原因是**CircleProgressView**里面的部分动画效果对于**SeekBar**并不适用,所以**ArcSeekBar**是在**CircleProgressView**的基础上有所删减后,而再进行扩展增强的。
之所以新造一个ArcSeekBar库,而不直接在 **CircleProgressView** 上面直接改,原因是 **CircleProgressView** 里面的部分动画效果对于 **SeekBar** 并不适用,所以 **ArcSeekBar** 是在 **CircleProgressView** 的基础上有所删减后,而再进行扩展增强的。
实际还需根据具体的需求而选择适合的。

## Gif 展示
Expand Down Expand Up @@ -99,13 +97,15 @@ ArcSeekBar for Android 是一个弧形的拖动条进度控件,配置参数完
arcSeekBar.showAnimation(80,3000);

```
更多使用详情,请查看[app](app)中的源码使用示例或直接查看 [API帮助文档](https://jitpack.io/com/github/jenly1314/ArcSeekBar/latest/javadoc/)
更多使用详情,请查看[app](app)中的源码使用示例或直接查看 [API帮助文档](https://jenly1314.github.io/ArcSeekBar/api/)

## 相关推荐

#### [CircleProgressView](https://github.com/jenly1314/CircleProgressView) 一个圆形的进度动画控件,动画效果纵享丝滑。

## 版本记录
<!-- end -->

## 版本日志

#### v1.1.1:2024-7-17
* 优化细节
Expand Down
23 changes: 23 additions & 0 deletions build_docs.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
#!/bin/bash

set -ex

# Generate the API docs
./gradlew dokkaHtml

mkdir -p docs/api
mv arcseekbar/build/dokka/html/* docs/api

# Copy in special files that GitHub wants in the project root.
GITHUB_URL=https://github.com/jenly1314/ArcSeekBar/
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 -r GIF.gif docs/GIF.gif
# cp app/src/main/ic_launcher-web.png docs/ic_logo.png

# Build the site locally
mkdocs build
86 changes: 86 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
# Project information
site_name: ArcSeekBar
site_url: https://jenly1314.github.io/ArcSeekBar/
site_description: "ArcSeekBar for Android"
site_author: Jenly
remote_branch: gh-pages
edit_uri: ""

# Repository
repo_name: ArcSeekBar
repo_url: https://github.com/jenly1314/ArcSeekBar

# Copyright
copyright: 'Copyright &copy; 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

0 comments on commit c638d15

Please sign in to comment.