From 70fbfb5be690f6e9690c01ebf0051ed47a9986a5 Mon Sep 17 00:00:00 2001 From: Shane <6071159+smashedr@users.noreply.github.com> Date: Sun, 22 Feb 2026 00:34:17 -0800 Subject: [PATCH] Add Docs --- .gitattributes | 1 + .github/workflows/docs.yaml | 62 +++++ .github/workflows/preview.yaml | 44 ++++ .gitignore | 11 +- README.md | 52 +++- Taskfile.yml | 10 +- docs/assets/css/extra.css | 6 + .../images.png => docs/assets/images/logo.png | Bin docs/assets/js/extra.js | 12 + docs/favicon.ico | Bin 0 -> 2283 bytes docs/index.md | 85 +++++++ docs/overrides/main.html | 31 +++ docs/snippets/install.md | 33 +++ docs/support.md | 54 +++++ docs/usage.md | 61 +++++ zensical.toml | 225 ++++++++++++++++++ 16 files changed, 673 insertions(+), 14 deletions(-) create mode 100644 .gitattributes create mode 100644 .github/workflows/docs.yaml create mode 100644 .github/workflows/preview.yaml create mode 100644 docs/assets/css/extra.css rename .github/assets/images.png => docs/assets/images/logo.png (100%) create mode 100644 docs/assets/js/extra.js create mode 100644 docs/favicon.ico create mode 100644 docs/index.md create mode 100644 docs/overrides/main.html create mode 100644 docs/snippets/install.md create mode 100644 docs/support.md create mode 100644 docs/usage.md create mode 100644 zensical.toml diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..bf02a51 --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +docs/** linguist-documentation diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml new file mode 100644 index 0000000..b175e03 --- /dev/null +++ b/.github/workflows/docs.yaml @@ -0,0 +1,62 @@ +name: "Docs" + +on: + workflow_dispatch: + push: + branches: [master] + paths: + - ".github/workflows/docs.yaml" + - "zensical.toml" + - "docs/**" + +env: + crawler-id: "" + purge-domain: "" + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +jobs: + docs: + name: "Docs" + runs-on: ubuntu-latest + timeout-minutes: 5 + + permissions: + pages: write + id-token: write + + environment: + name: docs + url: ${{ steps.zensical.outputs.page_url }} + + steps: + - name: "Zensical Action" + id: zensical + uses: cssnr/zensical-action@master + with: + prepare: 'sed -i "s/>Zensical<\/a>/>Zensical<\/a> v${ZENSICAL_VERSION}/" zensical.toml' + + - name: "Purge Cache" + if: ${{ env.purge-domain != '' }} + uses: cssnr/cloudflare-purge-cache-action@v2 + with: + zones: ${{ env.purge-domain }} + token: ${{ secrets.CLOUDFLARE_API_TOKEN }} + + - name: "Algolia Crawler" + if: ${{ env.crawler-id != '' }} + uses: cssnr/algolia-crawler-action@v1 + with: + crawler_id: ${{ env.crawler-id }} + crawler_user_id: ${{ secrets.CRAWLER_USER_ID }} + crawler_api_key: ${{ secrets.CRAWLER_API_KEY }} + + - name: "Send Notification" + if: ${{ !cancelled() }} + continue-on-error: true + uses: sarisia/actions-status-discord@eb045afee445dc055c18d3d90bd0f244fd062708 # v1.16.0 + with: + webhook: ${{ secrets.DISCORD_WEBHOOK }} + description: ${{ steps.zensical.outputs.page_url }} diff --git a/.github/workflows/preview.yaml b/.github/workflows/preview.yaml new file mode 100644 index 0000000..617f151 --- /dev/null +++ b/.github/workflows/preview.yaml @@ -0,0 +1,44 @@ +name: "Preview" + +on: + workflow_dispatch: + push: + branches-ignore: [master] + paths: + - ".github/workflows/preview.yaml" + - "zensical.toml" + - "docs/**" + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +jobs: + build: + name: "Build" + runs-on: ubuntu-latest + timeout-minutes: 5 + steps: + - name: "Zensical Action" + uses: cssnr/zensical-action@master + with: + upload: "artifact" + prepare: 'sed -i "s/>Zensical<\/a>/>Zensical<\/a> v${ZENSICAL_VERSION}/" zensical.toml' + + deploy: + name: "Deploy" + uses: cssnr/workflows/.github/workflows/deploy-static.yaml@master + needs: [build] + with: + name: "preview" + url: "https://dev-static.cssnr.com/remote-wallpaper-android" + robots: true + path: "remote-wallpaper-android" + secrets: + host: ${{ secrets.DEV_DEPLOY_HOST }} + port: ${{ secrets.DEV_DEPLOY_PORT }} + user: ${{ secrets.DEV_DEPLOY_USER }} + pass: ${{ secrets.DEV_DEPLOY_PASS }} + webhook: ${{ secrets.DISCORD_WEBHOOK }} + permissions: + contents: read diff --git a/.gitignore b/.gitignore index a828ca2..56fa412 100644 --- a/.gitignore +++ b/.gitignore @@ -2,8 +2,14 @@ .DS_Store .idea/ *.iml -**/build/ -**/dist/ +.vscode/ +.*cache* +node_modules/ +build/ +dist/ +out/ +*.dll +*.exe .gradle/ .kotlin/ captures/ @@ -15,3 +21,4 @@ local.properties *.logcat **/google-services.json **/firebase-adminsdk.json +site/ diff --git a/README.md b/README.md index 77d80f4..a713285 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ -[![GitHub Downloads](https://img.shields.io/github/downloads/cssnr/remote-wallpaper-android/total?logo=android)](https://github.com/cssnr/remote-wallpaper-android/releases/latest/download/app-release.apk) +[![GitHub Downloads](https://img.shields.io/github/downloads/cssnr/remote-wallpaper-android/total?logo=android)](https://github.com/cssnr/remote-wallpaper-android/releases) [![GitHub Release Version](https://img.shields.io/github/v/release/cssnr/remote-wallpaper-android?logo=github)](https://github.com/cssnr/remote-wallpaper-android/releases/latest) -[![AGP Version](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fcssnr%2Fremote-wallpaper-android%2Frefs%2Fheads%2Fmaster%2Fgradle%2Flibs.versions.toml&query=%24.versions.agp&logo=gradle&label=AGP)](https://github.com/cssnr/remote-wallpaper-android/blob/master/gradle/libs.versions.toml#L2) +[![AGP Version](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fcssnr%2Fremote-wallpaper-android%2Frefs%2Fheads%2Fmaster%2Fgradle%2Flibs.versions.toml&query=%24.versions.agp&logo=gradle&label=gradle)](https://github.com/cssnr/remote-wallpaper-android/blob/master/gradle/libs.versions.toml#L2) +[![APK Size](https://badges.cssnr.com/gh/release/cssnr/zipline-android/latest/asset/app-release.apk/size?label=apk)](https://github.com/cssnr/remote-wallpaper-android/releases/latest/download/app-release.apk) [![Workflow Lint](https://img.shields.io/github/actions/workflow/status/cssnr/remote-wallpaper-android/lint.yaml?logo=norton&logoColor=white&label=lint)](https://github.com/cssnr/remote-wallpaper-android/actions/workflows/lint.yaml) [![Workflow Release](https://img.shields.io/github/actions/workflow/status/cssnr/remote-wallpaper-android/release.yaml?logo=norton&logoColor=white&label=release)](https://github.com/cssnr/remote-wallpaper-android/actions/workflows/release.yaml) [![GitHub Last Commit](https://img.shields.io/github/last-commit/cssnr/remote-wallpaper-android?logo=listenhub&label=updated)](https://github.com/cssnr/remote-wallpaper-android/pulse) @@ -17,7 +18,8 @@ # Remote Wallpaper Android -[![GitHub Release](https://img.shields.io/github/v/release/cssnr/remote-wallpaper-android?style=for-the-badge&logo=android&label=Download%20Android%20APK&color=3ddc84)](https://github.com/cssnr/remote-wallpaper-android/releases/latest/download/app-release.apk) + +Remote Wallpaper Android - [Install](#Install) - [Setup](#Setup) @@ -39,6 +41,8 @@ Example Remotes: - https://picsum.photos/4800/2400 - https://images.cssnr.com/aviation +[![GitHub Release](https://img.shields.io/github/v/release/cssnr/remote-wallpaper-android?style=for-the-badge&logo=android&label=Download%20Android%20APK&color=3ddc84)](https://github.com/cssnr/remote-wallpaper-android/releases/latest/download/app-release.apk) + ## Install [![Get on GitHub](https://raw.githubusercontent.com/smashedr/repo-images/refs/heads/master/android/get80/github.png)](https://github.com/cssnr/remote-wallpaper-android/releases/latest/download/app-release.apk) @@ -65,7 +69,7 @@ should take you to the settings area to allow installation if not already enable 3. Choose the app you will install the apk file from. - Select your web browser to install directly from it. - Select your file manager to open it, locate the apk and install from there. -4. Download the [Latest Release](https://github.com/cssnr/remote-wallpaper-android/releases/latest/download/app-release.apk). +4. Download the Latest [app-release.apk](https://github.com/cssnr/remote-wallpaper-android/releases/latest/download/app-release.apk). 5. Open the download apk in the app you selected in step #3. 6. Choose Install and Accept any Play Protect notifications. 7. The app is now installed. Proceed to the [Setup](#Setup) section below. @@ -80,6 +84,8 @@ should take you to the settings area to allow installation if not already enable 4. Or Just Start the App and add a remote from the Remotes. 5. Optionally, add the Widget to refresh from the home screen. +[![View Documentation](https://img.shields.io/badge/view_documentation-blue?style=for-the-badge&logo=quicklook)](https://cssnr.github.io/remote-wallpaper-android/) + ## Features - Add any remote that redirects to a random image. @@ -93,11 +99,14 @@ should take you to the settings area to allow installation if not already enable - Image Effects; Blur, Grayscale, etc. - JSON Result Parser with Custom keys. -- [Submit a Feature Request](https://github.com/cssnr/remote-wallpaper-android/discussions/categories/feature-requests) +[Submit a Feature Request](https://github.com/cssnr/remote-wallpaper-android/issues/new?template=1-feature.yaml) ### Known Issues -- [Open an Issue](https://github.com/cssnr/remote-wallpaper-android/issues) +- The wallpaper cropping may not work as expected. +- Updates are done on intervals, not at specific times. + +[Open an Issue](https://github.com/cssnr/remote-wallpaper-android/issues) ## Screenshots @@ -119,19 +128,24 @@ should take you to the settings area to allow installation if not already enable For general help or to request a feature, see: - Q&A Discussion: https://github.com/cssnr/remote-wallpaper-android/discussions/categories/q-a -- Request a Feature: https://github.com/cssnr/remote-wallpaper-android/discussions/categories/feature-requests +- Request a Feature: https://github.com/cssnr/remote-wallpaper-android/issues/new?template=1-feature.yaml If you are experiencing an issue/bug or getting unexpected results, you can: - Report an Issue: https://github.com/cssnr/remote-wallpaper-android/issues - Chat with us on Discord: https://discord.gg/wXy6m2X8wY -- Provide General Feedback: [https://cssnr.github.io/feedback/](https://cssnr.github.io/feedback/?app=Remote%20Wallpaper%20Android) + +[![View Documentation](https://img.shields.io/badge/view_documentation-blue?style=for-the-badge&logo=quicklook)](https://cssnr.github.io/remote-wallpaper-android/support/) # Development +Documentation for building the [app](#app) and [docs](#docs). + +## App + This section briefly covers running and building in [Android Studio](#Android-Studio) and the [Command Line](#Command-Line). -## Android Studio +### Android Studio 1. Download and Install Android Studio. @@ -150,7 +164,7 @@ To Build: - Select the Build Variant (debug or release) - Build > Generate App Bundles or APK > Generate APKs -## Command Line +### Command Line _Note: This section is a WIP! For more details see the [release.yaml](.github/workflows/release.yaml)._ @@ -195,8 +209,26 @@ _Note: you may have to uninstall before installing due to different certificate For more details, see the [ADB Documentation](https://developer.android.com/tools/adb#move). +## Docs + +The [docs](docs) are built using [Zensical](https://github.com/cssnr/zensical-action). + +- + +```shell +task docs +``` + +A [Taskfile.yml](Taskfile.yml) is used run development commands. + +- + +_To easily install GitHub Release Binaries use [install-release](https://github.com/smashedr/install-release)._ + # Contributing +If you would like to submit a PR, please review the [CONTRIBUTING.md](#contributing-ov-file). + Please consider making a donation to support the development of this project and [additional](https://cssnr.com/) open source projects. diff --git a/Taskfile.yml b/Taskfile.yml index 713d1f5..0a8fd6c 100644 --- a/Taskfile.yml +++ b/Taskfile.yml @@ -2,6 +2,12 @@ version: "3" tasks: + docs: + desc: Zensical Docs + cmds: + - rm -rf .cache + - zensical serve --open + lint: desc: Lint cmds: @@ -12,8 +18,8 @@ tasks: format: desc: Format aliases: [fmt] - cmd: | - prettier --write . + cmds: + - prettier --write . build: desc: Build (recommended android studio) diff --git a/docs/assets/css/extra.css b/docs/assets/css/extra.css new file mode 100644 index 0000000..2827401 --- /dev/null +++ b/docs/assets/css/extra.css @@ -0,0 +1,6 @@ +/* Fix content shift on scrollbar */ +@supports (scrollbar-gutter: stable) { + html { + scrollbar-gutter: stable; + } +} diff --git a/.github/assets/images.png b/docs/assets/images/logo.png similarity index 100% rename from .github/assets/images.png rename to docs/assets/images/logo.png diff --git a/docs/assets/js/extra.js b/docs/assets/js/extra.js new file mode 100644 index 0000000..dabb938 --- /dev/null +++ b/docs/assets/js/extra.js @@ -0,0 +1,12 @@ +// Open External Links in New Tab +// noinspection JSUnresolvedReference,JSIgnoredPromiseFromCall +document$.subscribe(function () { + // console.log('documentLoaded:', globalThis.location) + for (const el of document.querySelectorAll("a")) { + // console.log('el.host:', el.host) + if (el.host && el.host !== globalThis.location.host) { + el.target = "_blank"; + el.rel = "noopener"; + } + } +}); diff --git a/docs/favicon.ico b/docs/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..1cdebd9832a51b0c9e7cc5a1f0bacae1fdd4e5fa GIT binary patch literal 2283 zcmZ`*c{tQv8~)9_Gnye{OvYAZtZ$kK7nSVFNCssoBU4!iVY1Fx#*#77jCEv9Q9?+{ z7Md(6%a>(RQFhsyj5iuvuW!1(Ki=>A4k^_ZlPalma|NE?0jKvp@!y*5ZA{jMJtf&?IZUv$#%EsSdm)aYZVb^Rg!$J-uBhi zGXuH89*+=b6J$$#B!~B9S1447-gNTolInR-?3eH6q^{}ObNwPA_lxH|iJ>qW4kj)3 zwdC9wKR(Y74*S;+!;`xc`0>bheK2ZhA?eTns1KTF1+y&w7!%>bm)4ttm#TG&G(C%$ z{G`%P33-PehwmOoAX{(O+G|1iI7}1<7WAETbYlrRb=QB)-m9dLfDy3%z8}mE({fc`RJt z-G>a08)ST-Wz4A0=|hfOD+MGCdYwD3eO4_}GY?><&Fe7gq7MIp-{WTy)I;4=?k%jj^hYfziDz>CkET?7M_>U6a0H( zGFPuEuZ?0~OM?uR`N?X&b2c8Q9;RSMygpbu8PlcF?5I_xOv}L8XsO7ti+P`9Bkz_H z5`q5NCdY5dRTI&<=Vm)y{D0ZJhJn7)-8|GgM`~`ze77;)?`oVmh@sMEy(Bh7tMZyo z{_6fn$x99cJtSqVcJ3|~E#6PjxEw*t!&<%srjzT(8%m$W>f%n0LK_*9qhuWF)F?SW zJ`8lpGNk+0%In!Iitqr&L@Jtg?HuufYvB2Tm?6Axh@JO}ot=_fGe1+!5AO(sCHw!J z;?&fK5mAJ!g4g5yqh#9YCXQ2g1%=}i>Fe8dpuzX0NP&a1-*U8z?fVhelh(IOw0@$w z;Fee0&)2`R^oh#>5C_Z1&>&T!X>gisU&1lx;3|*#F z8|rM0vf%xIFGMMd;P ztCXhHgL*n^qpovqkB#|+h0sifJs3c~762YA3lr1>bHGZKa@q=5cPwYB1@O-9TgyeW98eW+plmbSrHlB6(S9=FL{4ZZg zS~zrW@s^*p$7WeewsE#mZ*|7p%9>-`AQ(`G?0Ih^b}UoXk??e3uC;)mROagtnZ$7| zu&-L{(Fl1fXJA* zVzK`OEx}(ttv6M9a+<0*c*0&QT{%T^mCP}Nk zhC@CRU+d^6H!ZGB0?kfpB*iwuBX|0HJiA)A-^wp|eEyJQ-Z_To*!$91alZ6qh5 zO#1uATj+0MsiK;j_DN>O)-%4wSt zGlIe`NT`Uo=Z2AUh6y9}uh&ar=ng(M9uf){KeJ(!^Se0of`l%qIgr{CYiE;F>;;yT*IN3}psKg76#KS_3td z__HFD?Mzw-RiSHdN(v-sYOD(iZsc)Gl&B&TwuXXz>U?{H+`F5B`b8oW*PlfhaBc>Q z)e4&QQ(Oex`DgqE@P1_}0pV9f6M%`TqhA0}ZJQRVR1ssD2zJwxlxAKfIw$4(n0-ap zAAiewnWAFW`Csox(M0BdP$QEf(u|2M5TG9>^2 literal 0 HcmV?d00001 diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..afe51ba --- /dev/null +++ b/docs/index.md @@ -0,0 +1,85 @@ +--- +icon: lucide/rocket +--- + +# :lucide-rocket: Get Started + +[![Remote Wallpaper Android](assets/images/logo.png){ align=right width=96 }](https://github.com/cssnr/remote-wallpaper-android?tab=readme-ov-file#readme) + +

+ +[![GitHub Downloads](https://img.shields.io/github/downloads/cssnr/remote-wallpaper-android/total?logo=android)](https://github.com/cssnr/remote-wallpaper-android/releases) +[![GitHub Release Version](https://img.shields.io/github/v/release/cssnr/remote-wallpaper-android?logo=github)](https://github.com/cssnr/remote-wallpaper-android/releases/latest) +[![AGP Version](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fcssnr%2Fremote-wallpaper-android%2Frefs%2Fheads%2Fmaster%2Fgradle%2Flibs.versions.toml&query=%24.versions.agp&logo=gradle&label=gradle)](https://github.com/cssnr/remote-wallpaper-android/blob/master/gradle/libs.versions.toml#L2) +[![APK Size](https://badges.cssnr.com/gh/release/cssnr/zipline-android/latest/asset/app-release.apk/size?label=apk)](https://github.com/cssnr/remote-wallpaper-android/releases/latest/download/app-release.apk) +[![Workflow Lint](https://img.shields.io/github/actions/workflow/status/cssnr/remote-wallpaper-android/lint.yaml?logo=norton&logoColor=white&label=lint)](https://github.com/cssnr/remote-wallpaper-android/actions/workflows/lint.yaml) +[![Workflow Release](https://img.shields.io/github/actions/workflow/status/cssnr/remote-wallpaper-android/release.yaml?logo=norton&logoColor=white&label=release)](https://github.com/cssnr/remote-wallpaper-android/actions/workflows/release.yaml) +[![GitHub Last Commit](https://img.shields.io/github/last-commit/cssnr/remote-wallpaper-android?logo=listenhub&label=updated)](https://github.com/cssnr/remote-wallpaper-android/pulse) +[![GitHub Repo Size](https://img.shields.io/github/repo-size/cssnr/remote-wallpaper-android?logo=buffer&label=repo%20size)](https://github.com/cssnr/remote-wallpaper-android?tab=readme-ov-file#readme) +[![GitHub Top Language](https://img.shields.io/github/languages/top/cssnr/remote-wallpaper-android?logo=devbox)](https://github.com/cssnr/remote-wallpaper-android?tab=readme-ov-file#readme) +[![GitHub Contributors](https://img.shields.io/github/contributors-anon/cssnr/remote-wallpaper-android?logo=southwestairlines)](https://github.com/cssnr/remote-wallpaper-android/graphs/contributors) +[![GitHub Issues](https://img.shields.io/github/issues/cssnr/remote-wallpaper-android?logo=codeforces&logoColor=white)](https://github.com/cssnr/remote-wallpaper-android/issues) +[![GitHub Discussions](https://img.shields.io/github/discussions/cssnr/remote-wallpaper-android?logo=theconversation)](https://github.com/cssnr/remote-wallpaper-android/discussions) +[![GitHub Forks](https://img.shields.io/github/forks/cssnr/remote-wallpaper-android?style=flat&logo=forgejo&logoColor=white)](https://github.com/cssnr/remote-wallpaper-android/forks) +[![GitHub Repo Stars](https://img.shields.io/github/stars/cssnr/remote-wallpaper-android?style=flat&logo=gleam&logoColor=white)](https://github.com/cssnr/remote-wallpaper-android/stargazers) +[![GitHub Org Stars](https://img.shields.io/github/stars/cssnr?style=flat&logo=apachespark&logoColor=white&label=org%20stars)](https://cssnr.github.io/) +[![Discord](https://img.shields.io/discord/899171661457293343?logo=discord&logoColor=white&label=discord&color=7289da)](https://discord.gg/wXy6m2X8wY) +[![Ko-fi](https://img.shields.io/badge/Ko--fi-72a5f2?logo=kofi&label=support)](https://ko-fi.com/cssnr) + +

+ +Remote Wallpaper Android Application. + +Set wallpaper from remote URL's at a defined interval. Supports any link that redirects to an image. + +To get started, [Install](#install) the app, view the [Screenshots](#screenshots) and review the [Usage](usage.md). + +## :lucide-sparkles: Features + +- Add any remote that redirects to a random image. +- Automatically rotate at configurable intervals. +- Widget with refresh button and updated time. +- History of all wallpaper used with links. +- Option to crop wallpaper for device. + +### :lucide-calendar-clock: Planned + +- Image Effects; Blur, Grayscale, etc. +- JSON Result Parser with Custom keys. + +## :lucide-download: Install + +--8<-- "docs/snippets/install.md" + +If you run into any issues or have any questions, [support](support.md) is available. + +### Setup + +1. [Install](#install) and open the app on your device. +2. Select your update interval and initial remote. +3. Click Set wallpaper and Start to get the ball rolling. +4. Or Just Start the App and add a remote from the Remotes. +5. Optionally, add the Widget to refresh from the home screen. + +For more details, see the [Usage](usage.md) guide. + +## :lucide-camera: Screenshots + + + Screenshot + + Screenshot + + Screenshot + + Screenshot + + Screenshot + + Screenshot + +  + +!!! example "Questions" + + If you need **help** getting started or run into any issues, [support](support.md) is available! diff --git a/docs/overrides/main.html b/docs/overrides/main.html new file mode 100644 index 0000000..6a67fb6 --- /dev/null +++ b/docs/overrides/main.html @@ -0,0 +1,31 @@ +{% extends "base.html" %} {% block site_meta %} {{ super() }} {% set path = +'/cssnr/remote-wallpaper-android' %} + + + + + + + + + + + + + + + + + + + + + + +{% endblock %} diff --git a/docs/snippets/install.md b/docs/snippets/install.md new file mode 100644 index 0000000..e7e4fc5 --- /dev/null +++ b/docs/snippets/install.md @@ -0,0 +1,33 @@ +To begin install the application on your device _(Android 8+ API 26+)_. + +If you are unsure which provider to choose, [Obtainium :lucide-arrow-up-right:](https://obtainium.imranr.dev/) is recommended. + +[![Get on GitHub](https://raw.githubusercontent.com/smashedr/repo-images/refs/heads/master/badges/get-on/github.png)](https://github.com/django-files/android-client/releases/latest/download/app-release.apk) +[![Get on Obtainium](https://raw.githubusercontent.com/smashedr/repo-images/refs/heads/master/badges/get-on/obtainium.png)](https://apps.obtainium.imranr.dev/redirect?r=obtainium://add/https://github.com/cssnr/remote-wallpaper-android) + +[![Latest Release](https://img.shields.io/github/v/release/cssnr/remote-wallpaper-android?style=for-the-badge&logo=android&color=34A853&label=Latest%20Release)](https://github.com/cssnr/remote-wallpaper-android/releases/latest) +[![Latest Pre-Release](https://img.shields.io/github/v/release/cssnr/remote-wallpaper-android?style=for-the-badge&logo=android&label=Pre-Release&include_prereleases)](https://github.com/cssnr/remote-wallpaper-android/releases) + +??? abstract "View QR Codes" + + [![QR Code](https://raw.githubusercontent.com/smashedr/repo-images/refs/heads/master/remote-wallpaper/qr-code-github.png)](https://github.com/cssnr/remote-wallpaper-android/releases/latest/download/app-release.apk) + + [![QR Code](https://raw.githubusercontent.com/smashedr/repo-images/refs/heads/master/remote-wallpaper/qr-code-obtainium.png)](https://apps.obtainium.imranr.dev/redirect?r=obtainium://add/https://github.com/cssnr/remote-wallpaper-android/) + +_To install the apk directly you may need to allow installation from unknown sources. +For more information see, [Release through a website :lucide-arrow-up-right:](https://developer.android.com/studio/publish#publishing-website)._ + +??? note "View Manual Steps to Install from Unknown Sources" + + Note: Downloading and Installing the [apk](https://github.com/cssnr/remote-wallpaper-android/releases/latest/download/app-release.apk) + should take you to the settings area to allow installation if not already enabled. Otherwise: + + 1. Go to your device settings. + 2. Search for "Install unknown apps" or similar. + 3. Choose the app you will install the apk file from. + - Select your web browser to install directly from it. + - Select your file manager to open it, locate the apk and install from there. + 4. Download the Latest [app-release.apk](https://github.com/cssnr/remote-wallpaper-android/releases/latest/download/app-release.apk). + 5. Open the download apk in the app you selected in step #3. + 6. Choose Install and Accept any Play Protect notifications. + 7. The app is now installed. Proceed to the [Setup](#setup) section below. diff --git a/docs/support.md b/docs/support.md new file mode 100644 index 0000000..049b5b5 --- /dev/null +++ b/docs/support.md @@ -0,0 +1,54 @@ +--- +icon: lucide/message-circle-question-mark +--- + +# :lucide-message-circle-question-mark: Support + +[![Remote Wallpaper Android](assets/images/logo.png){ align=right width=96 }](https://github.com/cssnr/remote-wallpaper-android?tab=readme-ov-file#readme) + +[![Features](https://img.shields.io/badge/features-brightgreen?style=for-the-badge&logo=rocket&logoColor=white)](https://github.com/cssnr/remote-wallpaper-android/issues/new?template=1-feature.yaml) +[![Issues](https://img.shields.io/badge/issues-red?style=for-the-badge&logo=southwestairlines&logoColor=white)](https://github.com/cssnr/remote-wallpaper-android/issues) +[![Discussions](https://img.shields.io/badge/discussions-blue?style=for-the-badge&logo=theconversation)](https://github.com/cssnr/remote-wallpaper-android/discussions) +[![Discord](https://img.shields.io/badge/discord-5865F2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/wXy6m2X8wY) + +If you run into any [issues](https://github.com/cssnr/remote-wallpaper-android/issues), +want to see more [features](https://github.com/cssnr/remote-wallpaper-android/issues/new?template=1-feature.yaml) +or just have a [question](https://github.com/cssnr/remote-wallpaper-android/discussions/categories/q-a) +please let us know. +:material-information-outline:{ title="All issues will be responded too!" } + +## GitHub Discussions + +If you have a question or need help with anything, +start a discussion in [General](https://github.com/cssnr/remote-wallpaper-android/discussions/categories/general) +or [Q&A](https://github.com/cssnr/remote-wallpaper-android/discussions/categories/q-a). + +If you want to see a new feature, start a discussion in +the [Feature Requests](https://github.com/cssnr/remote-wallpaper-android/issues/new?template=1-feature.yaml) section. + +[:simple-theconversation:   Start A Discussion](https://github.com/cssnr/remote-wallpaper-android/discussions){ .md-button .md-button--primary } + +## GitHub Issues + +If you run into any problems or find a bug, please [open an issue](https://github.com/cssnr/remote-wallpaper-android/issues). + +**These reports are treated with the highest priority.** + +[:simple-southwestairlines:   Report an Issue](https://github.com/cssnr/remote-wallpaper-android/issues){ .md-button .md-button--primary } + +## Discord Chat + +You can chat with us about anything [on discord](https://discord.gg/wXy6m2X8wY). + +From here you can contact me directly, `Shane@111150265075298304`. + +[:fontawesome-brands-discord:   Chat on Discord](https://discord.gg/wXy6m2X8wY){ .md-button .md-button--primary } + +  + +More information available at: [https://cssnr.com/](https://cssnr.com/) + +[![Support on Ko-fi](https://cdn.prod.website-files.com/5c14e387dab576fe667689cf/670f5a01c01ea9191809398c_support_me_on_kofi_blue.png){ width="360" }](https://ko-fi.com/cssnr) + +![Star History](https://api.star-history.com/svg?repos=cssnr/remote-wallpaper-android&type=date&legend=bottom-right#only-light){ style="border-radius: 12px;" } +![Star History](https://api.star-history.com/svg?repos=cssnr/remote-wallpaper-android&type=date&legend=bottom-right&theme=dark#only-dark){ style="border-radius: 12px;" } diff --git a/docs/usage.md b/docs/usage.md new file mode 100644 index 0000000..6bea34d --- /dev/null +++ b/docs/usage.md @@ -0,0 +1,61 @@ +--- +icon: lucide/tablet-smartphone +--- + +# :lucide-tablet-smartphone: Usage + +[![Remote Wallpaper Android](assets/images/logo.png){ align=right width=96 }](https://github.com/cssnr/remote-wallpaper-android?tab=readme-ov-file#readme) + +- [Remotes](#remotes) +- [Widget](#widget) +- [Settings](#settings) + +## :lucide-router: Remotes + +Remotes are the heart of the application. A remote is a link to an image. +This can be a static image but you most likely have a link to a dynamic image or a redirect. + +Therefore, this application will refresh the image at the remote (image) url on a custom interval. + +Example Remotes: + +- +- + +## :lucide-layout-panel-top: Widget + +You can add a stats widget to the home screen to display info and functionality. + +![Stats Widget](https://raw.githubusercontent.com/smashedr/repo-images/refs/heads/master/remote-wallpaper/docs/widget.jpg){ style="border-radius: 16px;" } + +The widget displays the following information: + +- Current Remote +- Update Interval +- Last Updated Time + +The widget has the following functions: + +- Refresh Wallpaper +- Launch Application + +## :lucide-settings: Settings + +Application Settings: + +- Update Interval +- Screens to Update (Home/Lock) + +Widget Settings: + +- Text Color +- Background Color +- Background Opacity + +  + +!!! example "Support" + + These docs are still a work in progress are may not be complete. + + If you need **help** getting started or run into any issues, [support](support.md) is available! diff --git a/zensical.toml b/zensical.toml new file mode 100644 index 0000000..f962fcf --- /dev/null +++ b/zensical.toml @@ -0,0 +1,225 @@ +[project] +site_name = "Remote Wallpaper" +site_description = "Remote Wallpaper Android Application." +site_author = "Shane" +repo_name = "cssnr/remote-wallpaper-android" +repo_url = "https://github.com/cssnr/remote-wallpaper-android" +edit_uri = "blob/master/docs/" +# https://zensical.org/docs/setup/basics/#site_url +site_url = "https://cssnr.github.io/remote-wallpaper-android/" +# https://zensical.org/docs/setup/basics/#copyright +copyright = """ +Remote Wallpaper +
+Built with Zensical +""" +# https://zensical.org/docs/setup/navigation/ +nav = [ + { "Get Started" = "index.md" }, + { "Usage" = "usage.md" }, + { "Support" = "support.md" }, +] +# https://zensical.org/docs/customization/#additional-css +extra_css = ["assets/css/extra.css"] +# https://zensical.org/docs/customization/#additional-javascript +extra_javascript = ["assets/js/extra.js"] + +# ---------------------------------------------------------------------------- +# Section for configuring theme options +# ---------------------------------------------------------------------------- + +[project.theme] +# https://zensical.org/docs/setup/basics/?h=theme#theme-variant +# variant = "classic" + +# https://zensical.org/docs/customization/#extending-the-theme +custom_dir = "docs/overrides" +favicon = "assets/images/logo.png" +logo = "assets/images/logo.png" +# https://zensical.org/docs/setup/language/ +language = "en" +features = [ + # https://zensical.org/docs/setup/header/#announcement-bar + "announce.dismiss", + # https://zensical.org/docs/setup/repository/#code-actions + "content.action.edit", + # https://zensical.org/docs/setup/repository/#code-actions + # "content.action.view", + # https://zensical.org/docs/authoring/code-blocks/#code-annotations + "content.code.annotate", + # https://zensical.org/docs/authoring/code-blocks/#code-copy-button + "content.code.copy", + # https://zensical.org/docs/authoring/code-blocks/#code-selection-button + # "content.code.select", + # https://zensical.org/docs/authoring/footnotes/#footnote-tooltips + "content.footnote.tooltips", + # https://zensical.org/docs/authoring/content-tabs/#linked-content-tabs + "content.tabs.link", + # https://zensical.org/docs/authoring/tooltips/#improved-tooltips + "content.tooltips", + # https://zensical.org/docs/setup/header/#automatic-hiding + # "header.autohide", + # https://zensical.org/docs/setup/navigation/#navigation-expansion + # "navigation.expand", + # https://zensical.org/docs/setup/footer/#navigation + "navigation.footer", + # https://zensical.org/docs/setup/navigation/#section-index-pages + "navigation.indexes", + # https://zensical.org/docs/setup/navigation/#instant-navigation + "navigation.instant", + # https://zensical.org/docs/setup/navigation/#instant-prefetching + "navigation.instant.prefetch", + # https://zensical.org/docs/setup/navigation/#progress-indicator + # "navigation.instant.progress", + # https://zensical.org/docs/setup/navigation/#navigation-path + "navigation.path", + # https://zensical.org/docs/setup/navigation/#navigation-pruning + # "navigation.prune", + # https://zensical.org/docs/setup/navigation/#navigation-sections + "navigation.sections", + # https://zensical.org/docs/setup/navigation/#navigation-tabs + # "navigation.tabs", + # https://zensical.org/docs/setup/navigation/#sticky-navigation-tabs + # "navigation.tabs.sticky", + # https://zensical.org/docs/setup/navigation/#back-to-top-button + "navigation.top", + # https://zensical.org/docs/setup/navigation/#anchor-tracking + "navigation.tracking", + # https://zensical.org/docs/setup/search/#search-highlighting + "search.highlight", + # https://zensical.org/docs/setup/navigation/#anchor-following + # "toc.follow", + # https://zensical.org/docs/setup/navigation/#navigation-integration + "toc.integrate", +] + +# ---------------------------------------------------------------------------- +# In the "palette" subsection you can configure options for the color scheme. +# You can configure different color # schemes, e.g., to turn on dark mode, +# that the user can switch between. Each color scheme can be further +# customized. +# +# Read more: +# - https://zensical.org/docs/setup/colors/ +# ---------------------------------------------------------------------------- +# Palette toggle for automatic mode +[[project.theme.palette]] +media = "(prefers-color-scheme)" +toggle.icon = "lucide/sun-moon" +toggle.name = "Switch to light mode" + +# Palette toggle for light mode +[[project.theme.palette]] +media = "(prefers-color-scheme: light)" +scheme = "default" +primary = "purple" +accent = "light blue" +toggle.icon = "lucide/sun" +toggle.name = "Switch to dark mode" + +# Palette toggle for dark mode +[[project.theme.palette]] +media = "(prefers-color-scheme: dark)" +scheme = "slate" +primary = "purple" +accent = "amber" +toggle.icon = "lucide/moon" +toggle.name = "Switch to system preference" + +# ---------------------------------------------------------------------------- +# In the "font" subsection you can configure the fonts used. By default, fonts +# are loaded from Google Fonts, giving you a wide range of choices from a set +# of suitably licensed fonts. There are options for a normal text font and for +# a monospaced font used in code blocks. +# ---------------------------------------------------------------------------- +# [project.theme.font] +# text = "Inter" +# code = "Jetbrains Mono" + +# ---------------------------------------------------------------------------- +# Read more: +# - https://zensical.org/docs/setup/logo-and-icons +# - https://zensical.org/docs/authoring/icons-emojis/#search +# ---------------------------------------------------------------------------- +[project.theme.icon] +repo = "fontawesome/brands/github" +admonition = { abstract = "lucide/camera", example = "lucide/images" } + +# ---------------------------------------------------------------------------- +# The "extra" section contains miscellaneous settings. +# ---------------------------------------------------------------------------- + +[project.extra] +generator = false + +[[project.extra.social]] +icon = "fontawesome/brands/github" +link = "https://github.com/cssnr/remote-wallpaper-android" +name = "GitHub Repo" + +[[project.extra.social]] +icon = "fontawesome/brands/discord" +link = "https://discord.gg/wXy6m2X8wY" +name = "Discord" + +[[project.extra.social]] +icon = "simple/kofi" +link = "https://ko-fi.com/cssnr" +name = "Ko-fi" + +[[project.extra.social]] +icon = "fontawesome/solid/house-laptop" +link = "https://cssnr.github.io/" +name = "Website" + +# https://zensical.org/docs/setup/extensions/#default-configuration +[project.markdown_extensions.abbr] + +[project.markdown_extensions.admonition] + +[project.markdown_extensions.attr_list] + +[project.markdown_extensions.def_list] + +[project.markdown_extensions.footnotes] + +[project.markdown_extensions.md_in_html] + +[project.markdown_extensions.toc] +permalink = true + +[project.markdown_extensions.pymdownx.arithmatex] +generic = true + +[project.markdown_extensions.pymdownx.betterem] +smart_enable = "all" + +[project.markdown_extensions.pymdownx.caret] + +[project.markdown_extensions.pymdownx.details] + +[project.markdown_extensions.pymdownx.emoji] +emoji_generator = "zensical.extensions.emoji.to_svg" +emoji_index = "zensical.extensions.emoji.twemoji" + +[project.markdown_extensions.pymdownx.highlight] + +[project.markdown_extensions.pymdownx.inlinehilite] + +[project.markdown_extensions.pymdownx.keys] + +[project.markdown_extensions.pymdownx.mark] + +[project.markdown_extensions.pymdownx.smartsymbols] + +[project.markdown_extensions.pymdownx.superfences] + +[project.markdown_extensions.pymdownx.tabbed] +alternate_style = true + +[project.markdown_extensions.pymdownx.tasklist] +custom_checkbox = true + +[project.markdown_extensions.pymdownx.tilde] + +[project.markdown_extensions.pymdownx.snippets]