Add Docs

.gitattributes

@@ -0,0 +1 @@
+docs/** linguist-documentation

.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 }}

.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

.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/

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)
+<a title="Remote Wallpaper Android" href="https://cssnr.github.io/remote-wallpaper-android/" target="_blank">
+<img alt="Remote Wallpaper Android" align="right" width="128" height="auto" src="https://raw.githubusercontent.com/cssnr/remote-wallpaper-android/refs/heads/master/docs/assets/images/logo.png"></a>
 
 - [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).
+
+- <https://zensical.org/docs/get-started>
+
+```shell
+task docs
+```
+
+A [Taskfile.yml](Taskfile.yml) is used run development commands.
+
+- <https://taskfile.dev/docs/installation>
+
+_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.
 

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)

docs/assets/css/extra.css

@@ -0,0 +1,6 @@
+/* Fix content shift on scrollbar */
+@supports (scrollbar-gutter: stable) {
+  html {
+    scrollbar-gutter: stable;
+  }
+}

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";
+    }
+  }
+});

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)
+
+<p markdown="1" style="line-height: 1.2;" >
+
+[![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)
+
+</p>
+
+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
+
+<a title="Screenshot" href="https://raw.githubusercontent.com/smashedr/repo-images/refs/heads/master/remote-wallpaper/screenshots/1.jpg">
+    <img alt="Screenshot" src="https://raw.githubusercontent.com/smashedr/repo-images/refs/heads/master/remote-wallpaper/screenshots/1.jpg"></a>
+<a title="Screenshot" href="https://raw.githubusercontent.com/smashedr/repo-images/refs/heads/master/remote-wallpaper/screenshots/2.jpg">
+    <img alt="Screenshot" src="https://raw.githubusercontent.com/smashedr/repo-images/refs/heads/master/remote-wallpaper/screenshots/2.jpg"></a>
+<a title="Screenshot" href="https://raw.githubusercontent.com/smashedr/repo-images/refs/heads/master/remote-wallpaper/screenshots/3.jpg">
+    <img alt="Screenshot" src="https://raw.githubusercontent.com/smashedr/repo-images/refs/heads/master/remote-wallpaper/screenshots/3.jpg"></a>
+<a title="Screenshot" href="https://raw.githubusercontent.com/smashedr/repo-images/refs/heads/master/remote-wallpaper/screenshots/4.jpg">
+    <img alt="Screenshot" src="https://raw.githubusercontent.com/smashedr/repo-images/refs/heads/master/remote-wallpaper/screenshots/4.jpg"></a>
+<a title="Screenshot" href="https://raw.githubusercontent.com/smashedr/repo-images/refs/heads/master/remote-wallpaper/screenshots/5.jpg">
+    <img alt="Screenshot" src="https://raw.githubusercontent.com/smashedr/repo-images/refs/heads/master/remote-wallpaper/screenshots/5.jpg"></a>
+<a title="Screenshot" href="https://raw.githubusercontent.com/smashedr/repo-images/refs/heads/master/remote-wallpaper/screenshots/6.jpg">
+    <img alt="Screenshot" src="https://raw.githubusercontent.com/smashedr/repo-images/refs/heads/master/remote-wallpaper/screenshots/6.jpg"></a>
+
+&nbsp;
+
+!!! example "Questions"
+
+    If you need **help** getting started or run into any issues, [support](support.md) is available!