style: fix eslint

.circleci/conditional_config.yml

@@ -1,7 +1,7 @@
 version: 2.1
 
 orbs:
-  node: circleci/node@5.2.0
+  node: circleci/node@5.0.3
   codecov: codecov/codecov@3.3.0
 
 executors:
@@ -10,10 +10,10 @@ executors:
       - image: cimg/base:stable
   node:
     docker:
-      - image: "cimg/node:20.17.0"
+      - image: 'cimg/node:18.19.0'
   go:
     docker:
-      - image: cimg/go:1.22.6
+      - image: cimg/go:1.21.3
 
 parameters:
   trigger-app:
@@ -26,43 +26,43 @@ parameters:
 jobs:
   ## Backend
   test_app:
-    executor: go
-    working_directory: ~/go/src/github.com/ArtalkJS/Artalk
-    environment:
-      GO111MODULE: "on"
-    steps:
-      - checkout
-      - run:
-          name: "Print the Go version"
-          command: >
-            go version
-      - restore_cache:
-          keys:
-            - go-mod-1.22.6-{{ checksum "go.sum" }}
-      - run:
-          name: Install Dependencies
-          command: go mod download
-      - save_cache:
-          key: go-mod-1.22.6-{{ checksum "go.sum" }}
-          paths:
-            - "~/go/pkg/mod"
-      - run:
-          name: Run tests
-          command: |
-            mkdir -p /tmp/test-reports
-            gotestsum --junitfile /tmp/test-reports/unit-tests.xml -- -coverprofile=/tmp/test-reports/coverage.out ./...
-      - store_test_results:
-          path: /tmp/test-reports
-      - codecov/upload:
-          flags: go
-          file: /tmp/test-reports/coverage.out
+      executor: go
+      working_directory: ~/go/src/github.com/ArtalkJS/Artalk
+      environment:
+        GO111MODULE: "on"
+      steps:
+        - checkout
+        - run:
+            name: "Print the Go version"
+            command: >
+              go version
+        - restore_cache:
+            keys:
+              - go-mod-1.21.3-{{ checksum "go.sum" }}
+        - run:
+            name: Install Dependencies
+            command: go mod download
+        - save_cache:
+            key: go-mod-1.21.3-{{ checksum "go.sum" }}
+            paths:
+              - "~/go/pkg/mod"
+        - run:
+            name: Run tests
+            command: |
+              mkdir -p /tmp/test-reports
+              gotestsum --junitfile /tmp/test-reports/unit-tests.xml -- -coverprofile=/tmp/test-reports/coverage.out ./...
+        - store_test_results:
+            path: /tmp/test-reports
+        - codecov/upload:
+            flags: go
+            file: /tmp/test-reports/coverage.out
 
   all_projects:
-    executor: base
-    steps:
-      - run:
-          command: |
-            echo "all"
+      executor: base
+      steps:
+        - run:
+            command: |
+              echo "all"
 
 workflows:
   build-app:

.circleci/config.yml

@@ -17,11 +17,9 @@ workflows:
           mapping: |
             (cmd|internal|server|pkg|test|conf)/.*  trigger-app true
             main.go|go.mod|go.sum  trigger-app true
-          base-revision: master # git branch name
+          base-revision: master  # git branch name
           config-path: .circleci/conditional_config.yml
           filters:
             branches:
               ignore:
                 - gh-pages
-                - /release\/.+/
-                - nightly

.dockerignore

@@ -1 +0,0 @@
-node_modules

.github/FUNDING.yml

@@ -2,8 +2,7 @@
 
 github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
 patreon: # Replace with a single Patreon username
-open_collective: # Replace with a single Open Collective username
-buy_me_a_coffee: artalk
+open_collective: artalk # Replace with a single Open Collective username
 ko_fi: # Replace with a single Ko-fi username
 tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
 community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
@@ -12,4 +11,4 @@ issuehunt: # Replace with a single IssueHunt username
 otechie: # Replace with a single Otechie username
 lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
 custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
-  - https://afdian.com/a/artalk
+  - https://afdian.net/a/artalk

.github/actions/comment/action.yml

@@ -1,25 +0,0 @@
-name: Comment issue
-description: Create comment on a issue
-
-inputs:
-  issue_number:
-    required: true
-    description: The issue number you want to comment
-  content:
-    required: true
-    description: The content of comment
-
-runs:
-  using: "composite"
-  steps:
-    - uses: actions/github-script@v7
-      env:
-        STDOUT: ${{ inputs.content }}
-      with:
-        script: |
-          github.rest.issues.createComment({
-              issue_number: ${{ inputs.issue_number }},
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              body: process.env.STDOUT
-          })

.github/chglog/config.yml

@@ -4,8 +4,8 @@ info:
   title: CHANGELOG
   repository_url: https://github.com/ArtalkJS/Artalk
 options:
-  tag_filter_pattern: "^v"
-  sort: date
+  tag_filter_pattern: '^v'
+  sort: "date"
   commits:
     filters:
       Type:

.github/dependabot.yml

@@ -14,7 +14,7 @@ updates:
     groups:
       deps:
         patterns:
-          - "*"
+          - '*'
     open-pull-requests-limit: 15
 
   - package-ecosystem: npm
@@ -39,7 +39,7 @@ updates:
     groups:
       deps:
         patterns:
-          - "*"
+          - '*'
     open-pull-requests-limit: 15
 
   - package-ecosystem: docker
@@ -51,7 +51,7 @@ updates:
     groups:
       deps:
         patterns:
-          - "*"
+          - '*'
     open-pull-requests-limit: 15
 
   - package-ecosystem: github-actions
@@ -63,5 +63,5 @@ updates:
     groups:
       deps:
         patterns:
-          - "*"
+          - '*'
     open-pull-requests-limit: 15

.github/workflows/build-app.yml

@@ -1,18 +1,13 @@
 name: Build App
+run-name: Build Go App and Publish
 
 on:
-  workflow_call:
-    inputs:
-      version:
-        required: true
-        type: string
-      dry_run:
-        required: true
-        type: boolean
+  repository_dispatch:
+    types: [artalk-release]
 
 env:
-  GO_VERSION: 1.22.6
-  PKG_NAME: github.com/ArtalkJS/Artalk
+  GO_VERSION: '1.21.3'
+  PKG_NAME: 'github.com/ArtalkJS/Artalk'
   DOCKER_IMG: ghcr.io/goreleaser/goreleaser-cross
   CACHE_DIR: /tmp/cache/docker-image
 
@@ -22,12 +17,18 @@ jobs:
 
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v4
-        with:
-          ref: ${{ inputs.version }}
-          # `go-releaser` will read the semver version from git tag name
-          # `git-chglog` will diff the tag and generate changelog
-          fetch-depth: 0
+        uses: actions/checkout@v3
+
+      - name: Checkout latest tag
+        run: |
+          # fetch tags
+          git fetch --prune --unshallow --tags -f
+
+          # checkout latest version
+          VERSION=$(git describe --tags --abbrev=0)
+          git checkout ${VERSION}
+
+          echo "VERSION=${VERSION}" >> $GITHUB_ENV
 
       # disable cache because the err `no space left on device`
       # - name: Docker Image Cache
@@ -51,9 +52,9 @@ jobs:
 
       - name: Setup git-chglog
         run: |
-          curl -sL $(curl -s https://api.github.com/repos/git-chglog/git-chglog/releases/latest \
-            | grep -oP '"https://.+linux_amd64.tar.gz"' | tr -d \") | tar -C /usr/local/bin -xz git-chglog
-          git-chglog --version
+            curl -sL $(curl -s https://api.github.com/repos/git-chglog/git-chglog/releases/latest \
+              | grep -oP '"https://.+linux_amd64.tar.gz"' | tr -d \") | tar -C /usr/local/bin -xz git-chglog
+            git-chglog --version
 
       - name: Pre Build
         run: |-
@@ -63,14 +64,11 @@ jobs:
           echo "GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }}" > local/.release-env
 
           # changelog
-          git-chglog --config .github/chglog/config.yml ${{ inputs.version }} > local/release-notes.md
+          git-chglog --config .github/chglog/config.yml ${VERSION} > local/release-notes.md
 
           # copy config file
           cp conf/artalk.example.yml artalk.yml
 
-      - name: Print Relase Notes
-        run: cat local/release-notes.md
-
       - name: Build and Release
         run: |
           docker run \
@@ -83,4 +81,4 @@ jobs:
             -e CGO_ENABLED=1 \
             --env-file local/.release-env \
             ghcr.io/goreleaser/goreleaser-cross:v${GO_VERSION} \
-            release --release-notes local/release-notes.md ${{ inputs.dry_run && '--skip=publish' || '' }}
+            release --release-notes local/release-notes.md

.github/workflows/build-docker.yml

@@ -1,17 +1,9 @@
 name: Build Docker
+run-name: Build Docker Image and Publish
 
 on:
-  workflow_call:
-    inputs:
-      version:
-        required: true
-        type: string
-      dry_run:
-        required: true
-        type: boolean
-      target:
-        required: true
-        type: string
+  repository_dispatch:
+    types: [artalk-release]
 
 env:
   DOCKER_IMG: artalk/artalk-go
@@ -22,14 +14,58 @@ jobs:
 
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v3
+
+      - name: Checkout latest tag
+        run: |
+          # fetch tags
+          git fetch --prune --unshallow --tags -f
+
+          # checkout latest version
+          VERSION=$(git describe --tags --abbrev=0)
+          git checkout ${VERSION}
+
+          VERSION_SHORT="$(cut -d '.' -f 1,2 <<< ${VERSION#v})" # (i.e "v1.2.3" -> "1.2")
+          COMMIT_HASH="$(git rev-parse --short HEAD)"
+          COMMIT_HASH_FULL="$(git rev-parse HEAD)"
+
+          echo "VERSION=${VERSION}" >> $GITHUB_ENV
+          echo "VERSION_SHORT=${VERSION_SHORT}" >> $GITHUB_ENV
+          echo "COMMIT_HASH=${COMMIT_HASH}" >> $GITHUB_ENV
+          echo "COMMIT_HASH_FULL=${COMMIT_HASH_FULL}" >> $GITHUB_ENV
+
+      # https://github.com/docker/login-action
+      - name: Login to DockerHub
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v2
         with:
-          ref: ${{ inputs.version }}
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      # https://github.com/docker/setup-qemu-action
+      - name: Setup QEMU
+        id: qemu
+        uses: docker/setup-qemu-action@v2
+        with:
+          platforms: 'amd64,arm64'
+
+      # https://github.com/docker/setup-buildx-action
+      - name: Setup Docker Buildx
+        id: buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Cache Docker layers
+        uses: actions/cache@v3
+        with:
+          path: /tmp/.buildx-cache
+          key: ${{ runner.os }}-buildx-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-buildx-
 
       # https://github.com/docker/metadata-action
       - name: Gen docker meta
         id: meta
-        uses: docker/metadata-action@v5
+        uses: docker/metadata-action@v4
         with:
           context: git
           images: |
@@ -41,42 +77,34 @@ jobs:
             type=semver,pattern={{major}}.{{minor}}
             type=sha
 
-      # https://github.com/docker/login-action
-      - name: Login to DockerHub
-        uses: docker/login-action@v3
-        with:
-          username: ${{ secrets.DOCKERHUB_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
-
-      # https://github.com/docker/setup-qemu-action
-      - name: Setup QEMU
-        uses: docker/setup-qemu-action@v3
-        with:
-          platforms: ${{ inputs.target }}
-
-      # https://github.com/docker/setup-buildx-action
-      - name: Setup Docker Buildx
-        uses: docker/setup-buildx-action@v3
-
-      # Build UI outside of Docker to speed up cross-platform builds
-      - name: Build UI
-        run: |
-          make build-frontend
-
       # https://github.com/docker/build-push-action
       - name: Build and Push
-        id: build
-        uses: docker/build-push-action@v6
+        id: docker_build
+        uses: docker/build-push-action@v4
         with:
-          push: ${{ !inputs.dry_run }}
-          context: .
+          builder: ${{ steps.buildx.outputs.name }}
+          context: ./
           file: ./Dockerfile
-          build-args: |
-            APP_VERSION=${{ inputs.version }}
-            SKIP_UI_BUILD=true
-          platforms: ${{ inputs.target }}
+          platforms: 'linux/amd64,linux/arm64'
+          push: true
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+
+      - name: Comment build info in commit
+        uses: actions/github-script@v6
+        env:
+          STDOUT: "🐳 Published new docker image: [${{ env.DOCKER_IMG }}](https://hub.docker.com/r/${{ env.DOCKER_IMG }}) (${{ env.VERSION }} / sha-${{ env.COMMIT_HASH }})"
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            github.rest.repos.createCommitComment({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              commit_sha: process.env.COMMIT_HASH_FULL, // context.sha
+              body: process.env.STDOUT
+            })
 
       - name: Print image digest
-        run: echo ${{ steps.build.outputs.digest }}
+        run: echo ${{ steps.docker_build.outputs.digest }}

.github/workflows/build-done.yml

@@ -1,31 +0,0 @@
-name: Build Done
-
-on:
-  workflow_call:
-    inputs:
-      version:
-        required: true
-        type: string
-      dry_run:
-        required: true
-        type: boolean
-      issue_number:
-        required: true
-        type: number
-
-jobs:
-  done:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout Code
-        uses: actions/checkout@v4
-        with:
-          ref: ${{ inputs.version }}
-
-      - name: Comment done info
-        uses: ./.github/actions/comment
-        if: ${{ inputs.issue_number != 0 }}
-        with:
-          issue_number: ${{ inputs.issue_number }}
-          content: |-
-            🎉 Finished build and publish ${{ inputs.version }} ([NPM Package](https://www.npmjs.com/package/artalk?activeTab=versions) / [Docker Image](https://hub.docker.com/r/artalk/artalk-go/tags) / [Github Release](https://github.com/ArtalkJS/Artalk/releases/tag/${{ inputs.version }})).

.github/workflows/build-frontend.yml

@@ -0,0 +1,58 @@
+name: Build Frontend
+run-name: Build Frontend and Publish
+
+on:
+  repository_dispatch:
+    types: [artalk-release]
+
+jobs:
+  build_publish:
+    runs-on: ubuntu-latest
+
+    defaults:
+      run:
+        working-directory: ./ui  # set for building frontend
+
+    steps:
+    - name: Checkout Code
+      uses: actions/checkout@v3
+
+    - name: Checkout latest tag
+      run: |
+        git fetch --prune --unshallow --tags -f
+        git checkout $(git describe --tags --abbrev=0)
+
+    - name: Use pnpm
+      uses: pnpm/action-setup@v2
+      with:
+        version: 8
+
+    - name: Setup node
+      uses: actions/setup-node@v3
+      with:
+        node-version: 18.x
+        registry-url: https://registry.npmjs.org/
+        cache: 'pnpm'
+        cache-dependency-path: './ui/pnpm-lock.yaml'
+
+    - name: Install dependencies
+      run: pnpm install
+
+    - name: Build
+      run: pnpm build
+
+    - name: Publish
+      run: pnpm publish -F artalk --no-git-checks
+      env:
+        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+    # GitHub Packages
+    #
+    # Setup .npmrc file to publish to GitHub Packages
+    # - uses: actions/setup-node@v2
+    #   with:
+    #     registry-url: 'https://npm.pkg.github.com'
+    # # Publish to GitHub Packages
+    # - run: npm publish
+    #   env:
+    #     NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/build-nightly.yml

@@ -1,361 +0,0 @@
-name: Build Nightly
-run-name: Build Nightly
-
-on:
-  schedule:
-    - cron: "0 10 * * *"
-  workflow_dispatch:
-    inputs:
-      dry_run:
-        description: "Dry run"
-        type: boolean
-        default: true
-
-env:
-  DIST_DIR: /tmp/builds
-  DIGEST_DIR: /tmp/digests
-  DOCKER_IMG: artalk/artalk-go
-  DOCKER_BUILD_ARGS: |-
-    SKIP_UI_BUILD=true
-
-jobs:
-  # Prepare check should run
-  prepare:
-    runs-on: ubuntu-latest
-    outputs:
-      skip: ${{ steps.check.outputs.skip }}
-    steps:
-      - name: Checkout Code
-        uses: actions/checkout@v4
-
-      - name: Check should run
-        id: check
-        if: github.event_name == 'schedule'
-        run: |
-          if [[ "$(git log --since='24 hours ago' | wc -l)" -eq 0 ]] || \
-            [[ "$GITHUB_REPOSITORY" != "ArtalkJS/Artalk" ]]; then
-            echo "skip=true" >> $GITHUB_OUTPUT
-          fi
-
-  # Bulid UI first
-  # (build ui outside of docker to speed up cross-platform builds)
-  ui:
-    if: ${{ needs.prepare.outputs.skip != 'true' }}
-    needs: prepare
-    runs-on: macos-14
-    steps:
-      - name: Checkout Code
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-      - name: Setup pnpm
-        uses: pnpm/action-setup@v4
-        with:
-          version: 9.9.0
-
-      - name: Setup node
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20.x
-          registry-url: https://registry.npmjs.org/
-          cache: "pnpm"
-
-      - name: Get pnpm store directory
-        shell: bash
-        run: |
-          echo "PNPM_STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
-
-      - uses: actions/cache@v4
-        name: Setup pnpm cache
-        with:
-          path: ${{ env.PNPM_STORE_PATH }}
-          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
-          restore-keys: |
-            ${{ runner.os }}-pnpm-store-
-
-      - name: Install dependencies
-        run: pnpm install --frozen-lockfile
-
-      - name: Build UI
-        run: |
-          make build-frontend
-
-      - name: Pack UI
-        id: pack
-        run: |
-          SRC_FILE=$(pnpm pack -C ui/artalk --pack-destination ../.. | tail -n 1)
-
-          mkdir -p bin
-          PKG_FILE="bin/artalk_frontend_nigthly_$(date +'%Y%m%d').tar.gz"
-
-          mv $SRC_FILE $PKG_FILE
-          echo "pkg_file=$PKG_FILE" >> $GITHUB_OUTPUT
-
-      - name: Upload UI
-        uses: actions/upload-artifact@v4
-        with:
-          name: ui-src
-          path: |
-            public
-            ui/artalk/dist
-          if-no-files-found: error
-          retention-days: 1
-
-      - name: Upload UI package
-        uses: actions/upload-artifact@v4
-        with:
-          name: build-ui-pkg
-          path: ${{ steps.pack.outputs.pkg_file }}
-          retention-days: 1
-
-  #
-  # Build app on different platforms
-  #
-  build:
-    needs: ui
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        os:
-          - ubuntu-latest
-          # - macos-14
-          # :(
-          # native Apple m1 arm64 is not supported nested virtualization yet, so docker qemu is not working.
-          # https://github.com/actions/runner-images/issues/9460
-          # https://docs.veertu.com/anka/anka-virtualization-cli/nested-virtualization/
-          #
-          # wait for arm64 linux runner support on github actions.
-        platform:
-          - linux/amd64
-          - linux/arm64
-        # exclude:
-        #   # exclude build x86 on arm, and vice versa.
-        #   - { os: macos-14, platform: linux/amd64 }
-        #   - { os: ubuntu-latest, platform: linux/arm64 }
-
-    steps:
-      - name: Prepare
-        run: |
-          PF="${{ matrix.platform }}"
-          echo "PLATFORM_PAIR=${PF//\//_}" >> $GITHUB_ENV
-
-      - name: Checkout Code
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-      - name: Setup docker on macos
-        if: startsWith(matrix.os, 'macos')
-        uses: crazy-max/ghaction-setup-docker@v3
-
-      - name: Gen docker meta
-        id: meta
-        uses: docker/metadata-action@v5
-        with:
-          images: ${{ env.DOCKER_IMG }}
-          tags: type=raw,value=nightly
-
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v3
-
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3
-
-      - name: Login to DockerHub
-        uses: docker/login-action@v3
-        with:
-          username: ${{ secrets.DOCKERHUB_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
-
-      - name: Download UI before build
-        uses: actions/download-artifact@v4
-        with:
-          name: ui-src
-
-      - name: Build and push by digest
-        uses: docker/build-push-action@v6
-        id: build
-        with:
-          context: .
-          platforms: ${{ matrix.platform }}
-          labels: ${{ steps.meta.outputs.labels }}
-          build-args: ${{ env.DOCKER_BUILD_ARGS }}
-          # The `type=image,push=true` must the last one,
-          # because the `build.outputs.digest` will output the last image's digest.
-          # The digests will be used in the merge step.
-          outputs: |
-            type=docker,name=${{ env.DOCKER_IMG }}
-            type=image,push=true,name=${{ env.DOCKER_IMG }},push-by-digest=true,name-canonical=true
-
-      - name: Export digest
-        run: |
-          mkdir -p $DIGEST_DIR
-          digest="${{ steps.build.outputs.digest }}"
-          touch "$DIGEST_DIR/${digest#sha256:}"
-
-      - name: Upload digest
-        uses: actions/upload-artifact@v4
-        with:
-          name: digests-${{ env.PLATFORM_PAIR }}
-          path: ${{ env.DIGEST_DIR }}/*
-          if-no-files-found: error
-          retention-days: 1
-
-      # Export docker image
-      - name: Export Docker Image
-        id: docker
-        run: |
-          IMG_FILE="artalk_docker_nigthly_$(date +'%Y%m%d')_${PLATFORM_PAIR}.tar.gz"
-          docker save ${{ env.DOCKER_IMG }} | gzip > $IMG_FILE
-          echo "img_file=$IMG_FILE" >> $GITHUB_OUTPUT
-
-      # App
-      - name: Pack app
-        id: app
-        run: |
-          BASE_DIR="/tmp/app_pkg"
-          NAME="artalk_nigthly_$(date +'%Y%m%d')_${PLATFORM_PAIR}"
-          SUB_DIR="$BASE_DIR/$NAME"
-          PKG_FILE="$BASE_DIR/$NAME.tar.gz"
-
-          # bin file
-          mkdir -p $SUB_DIR
-          docker run --rm --entrypoint cat ${{ env.DOCKER_IMG }} /artalk > "$SUB_DIR/artalk"
-          chmod +x "$SUB_DIR/artalk"
-
-          # doc file
-          cp conf/artalk.example.yml "$SUB_DIR/artalk.yml"
-          cp README.md LICENSE CHANGELOG.md "$SUB_DIR"
-
-          # create package file
-          tar -czf $PKG_FILE -C $BASE_DIR $NAME
-          echo "app_pkg_file=$PKG_FILE" >> $GITHUB_OUTPUT
-
-      # Move build artifacts
-      - name: Move build artifacts
-        run: |
-          mkdir -p $DIST_DIR
-          mv ${{ steps.app.outputs.app_pkg_file }} $DIST_DIR
-          mv ${{ steps.docker.outputs.img_file }} $DIST_DIR
-
-      # Upload build artifacts
-      - name: Upload build artifacts
-        uses: actions/upload-artifact@v4
-        with:
-          name: build-${{ env.PLATFORM_PAIR }}
-          path: ${{ env.DIST_DIR }}/*
-          if-no-files-found: error
-          retention-days: 1
-
-  # Merge docker digests from different platforms
-  # Reference: https://docs.docker.com/build/ci/github-actions/multi-platform/#distribute-build-across-multiple-runners
-  docker_merge:
-    runs-on: ubuntu-latest
-    needs: build
-    steps:
-      - name: Download digests
-        uses: actions/download-artifact@v4
-        with:
-          path: ${{ env.DIGEST_DIR }}
-          pattern: digests-*
-          merge-multiple: true
-
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3
-
-      - name: Docker meta
-        id: meta
-        uses: docker/metadata-action@v5
-        with:
-          images: ${{ env.DOCKER_IMG }}
-          tags: type=raw,value=nightly
-
-      - name: Login to Docker Hub
-        uses: docker/login-action@v3
-        with:
-          username: ${{ secrets.DOCKERHUB_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
-
-      - name: Create manifest list and push
-        working-directory: ${{ env.DIGEST_DIR }}
-        run: |
-          TAGS_ARG=$(jq -cr '.tags | map("-t " + .) | join(" ")' <<< "$DOCKER_METADATA_OUTPUT_JSON")
-          MINIFEST_SRCS=$(printf '${{ env.DOCKER_IMG }}@sha256:%s ' *)
-
-          docker buildx imagetools create ${TAGS_ARG} ${MINIFEST_SRCS}
-
-      - name: Inspect image
-        run: |
-          docker buildx imagetools inspect ${{ env.DOCKER_IMG }}:${{ steps.meta.outputs.version }}
-
-  # Release
-  release:
-    runs-on: ubuntu-latest
-    needs: build
-    steps:
-      - name: Checkout Code
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-      - name: Download builds
-        uses: actions/download-artifact@v4
-        with:
-          path: ${{ env.DIST_DIR }}
-          pattern: build-*
-          merge-multiple: true
-
-      # Generate CHANGELOG
-      - name: Generate Changelog
-        run: |
-          # install git-chglog
-          curl -sL $(curl -s https://api.github.com/repos/git-chglog/git-chglog/releases/latest \
-              | grep -oP '"https://.+linux_amd64.tar.gz"' | tr -d \") | tar -C /usr/local/bin -xz git-chglog
-
-          CHANGELOG=$(git-chglog --config .github/chglog/config.yml --next-tag nightly nightly)
-          MD_FILE="/tmp/changelog.md"
-          echo -e "$CHANGELOG" > $MD_FILE
-          echo -e "\n> [!NOTE]\n" \
-                  "> The Nightly version, automatically built based on the latest code, " \
-                  "is not yet released and may be unstable. Please use it with caution. " \
-                  "Docker user can run \`docker pull artalk/artalk-go:nightly\` to get " \
-                  "the nightly build." >> $MD_FILE
-
-      # checksums.txt
-      - name: Calculate checksums.txt
-        run: |
-          cd $DIST_DIR
-          sha256sum * > checksums.txt
-
-          # print checksums.txt
-          cat checksums.txt
-
-          FILES=$(find ${DIST_DIR} -type f -exec readlink -f {} \;)
-          echo -e "RELEASE_FILES<<EOF" >> $GITHUB_ENV
-          echo -e "$FILES" >> $GITHUB_ENV
-          echo -e "EOF" >> $GITHUB_ENV
-
-      - name: Create tag and push
-        env:
-          GH_TOKEN: ${{ github.token }}
-        run: |
-          git config user.name github-actions[bot]
-          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
-
-          gh release delete nightly --yes || true
-          git push origin :refs/tags/nightly || true
-
-          git tag -f nightly
-          git push -f origin nightly
-
-      - name: Release
-        uses: softprops/action-gh-release@v2
-        with:
-          prerelease: true
-          tag_name: nightly
-          name: 🧪 Nightly Version
-          body_path: /tmp/changelog.md
-          files: ${{ env.RELEASE_FILES }}
-          draft: false

.github/workflows/build-tagging.yml

@@ -1,61 +0,0 @@
-name: Build Pre Tagging
-
-on:
-  workflow_call:
-    inputs:
-      dry_run:
-        required: true
-        type: boolean
-      issue_number:
-        required: true
-        type: number
-    outputs:
-      version:
-        description: "Version"
-        value: ${{ jobs.tagging.outputs.version }}
-
-jobs:
-  tagging:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Get release version
-        run: |
-          # `github.head_ref` only exists for pull_request events
-          REF="${{ github.head_ref || github.ref }}"
-          VERSION="${REF#refs/tags/}"
-          VERSION="${VERSION#refs/heads/}"
-          VERSION="${VERSION#release/}"
-
-          echo "Version: $VERSION"
-          echo "VERSION=$VERSION" >> $GITHUB_ENV
-
-          if [[ ! "$VERSION" =~ ^v[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
-            echo "Invalid version format: $VERSION, please check git ref or tag."
-            exit 1
-          fi
-
-      - name: Checkout Code
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-      - name: Create Tag
-        run: |
-          if [ ! $(git tag -l "${VERSION}") ]; then
-            git config user.name github-actions[bot]
-            git config user.email 41898282+github-actions[bot]@users.noreply.github.com
-            git tag -a $VERSION -m "Release $VERSION"
-            git push origin $VERSION
-          else
-            echo "Skip creating tag $VERSION, already exists."
-          fi
-
-      - name: Comment tag info to PR
-        uses: ./.github/actions/comment
-        if: ${{ inputs.issue_number != 0 }}
-        with:
-          issue_number: ${{ inputs.issue_number }}
-          content: |-
-            🔖 Tagged version [${{ env.VERSION }}](https://github.com/ArtalkJS/Artalk/tree/${{ env.VERSION }}) and updated the [CHANGELOG.md](https://github.com/ArtalkJS/Artalk/blob/master/CHANGELOG.md).
-    outputs:
-      version: ${{ env.VERSION }}

.github/workflows/build-ui.yml

@@ -1,55 +0,0 @@
-name: Build UI
-
-on:
-  workflow_call:
-    inputs:
-      version:
-        required: true
-        type: string
-      dry_run:
-        required: true
-        type: boolean
-
-jobs:
-  build_publish:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout Code
-        uses: actions/checkout@v4
-        with:
-          ref: ${{ inputs.version }}
-
-      - name: Use pnpm
-        uses: pnpm/action-setup@v4
-        with:
-          version: 9.9.0
-
-      - name: Setup node
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20.x
-          registry-url: https://registry.npmjs.org/
-          cache: "pnpm"
-
-      - name: Install dependencies
-        run: pnpm install --frozen-lockfile
-
-      - name: Build
-        run: pnpm build
-
-      - name: Publish
-        run: pnpm publish -F artalk --no-git-checks ${{ inputs.dry_run && '--dry-run' || '' }}
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-
-      # GitHub Packages
-      #
-      # Setup .npmrc file to publish to GitHub Packages
-      # - uses: actions/setup-node@v4
-      #   with:
-      #     registry-url: 'https://npm.pkg.github.com'
-      # # Publish to GitHub Packages
-      # - run: npm publish
-      #   env:
-      #     NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/build.yml

@@ -1,82 +0,0 @@
-name: Build and Publish
-run-name: Build and Publish (${{ github.head_ref || github.ref }}) ${{ inputs.dry_run && '(🧪 Dry-Run)' || '' }}
-
-on:
-  pull_request:
-    branches: [master]
-    types: [closed]
-
-  workflow_dispatch:
-    inputs:
-      dry_run:
-        description: "Dry run"
-        type: boolean
-        default: true
-      build_items:
-        description: "Build items"
-        type: string
-        default: "ui,app,docker"
-
-jobs:
-  # Tag the release version code before building
-  # Getting the version code from the branch name or git ref.
-  tagging:
-    # Only run on manual trigger
-    # or when a PR is merged into master.
-    # (which the branch name start with `relase/`)
-    if: |
-      github.event_name == 'workflow_dispatch' ||
-      (github.event.pull_request.merged == true && startsWith(github.head_ref, 'release/'))
-    uses: ./.github/workflows/build-tagging.yml
-    with:
-      issue_number: ${{ github.event.pull_request.number || 0 }}
-      dry_run: ${{ inputs.dry_run || false }}
-    secrets: inherit
-
-  # Build the UI
-  ui:
-    if: inputs.build_items == '' || contains(inputs.build_items, 'ui')
-    needs: tagging
-    uses: ./.github/workflows/build-ui.yml
-    with:
-      version: ${{ needs.tagging.outputs.version }}
-      dry_run: ${{ inputs.dry_run || false }}
-    secrets: inherit
-
-  # Build the Docker image
-  docker:
-    if: inputs.build_items == '' || contains(inputs.build_items, 'docker')
-    needs: tagging
-    uses: ./.github/workflows/build-docker.yml
-    # Parallel build the multi-arch docker image
-    strategy:
-      matrix:
-        # since docker push actions will override the previous images,
-        # so need to build `linux/amd64` and push first,
-        # then build `linux/amd64` twice with other archs (build very slow so keep it last).
-        target: ["linux/amd64", "linux/amd64,linux/arm64"]
-    with:
-      version: ${{ needs.tagging.outputs.version }}
-      dry_run: ${{ inputs.dry_run || false }}
-      target: ${{ matrix.target }}
-    secrets: inherit
-
-  # Build the binary app
-  app:
-    if: inputs.build_items == '' || contains(inputs.build_items, 'app')
-    needs: tagging
-    uses: ./.github/workflows/build-app.yml
-    with:
-      version: ${{ needs.tagging.outputs.version }}
-      dry_run: ${{ inputs.dry_run || false }}
-    secrets: inherit
-
-  # All builds are complete
-  done:
-    needs: [tagging, ui, docker, app]
-    uses: ./.github/workflows/build-done.yml
-    with:
-      version: ${{ needs.tagging.outputs.version }}
-      issue_number: ${{ github.event.pull_request.number || 0 }}
-      dry_run: ${{ inputs.dry_run || false }}
-    secrets: inherit

.github/workflows/codeql.yml

@@ -9,18 +9,16 @@
 # the `language` matrix defined below to confirm you have the correct set of
 # supported CodeQL languages.
 #
-name: CodeQL
+name: "CodeQL"
 
 on:
   push:
-    branches:
-      - master
+    branches: [ "master" ]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches:
-      - master
+    branches: [ "master" ]
   schedule:
-    - cron: "40 17 * * 4"
+    - cron: '40 17 * * 4'
 
 jobs:
   analyze:
@@ -34,44 +32,43 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        language:
-          - go
-          - javascript
+        language: [ 'go', 'javascript' ]
         # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
         # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
 
     steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
+    - name: Checkout repository
+      uses: actions/checkout@v3
 
-      # Initializes the CodeQL tools for scanning.
-      - name: Initialize CodeQL
-        uses: github/codeql-action/init@v3
-        with:
-          languages: ${{ matrix.language }}
-          # If you wish to specify custom queries, you can do so here or in a config file.
-          # By default, queries listed here will override any specified in a config file.
-          # Prefix the list here with "+" to use these queries and those in the config file.
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
 
-          # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
-          # queries: security-extended,security-and-quality
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
 
-      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-      # If this step fails, then you should remove it and run the build manually (see below)
-      - name: Autobuild
-        uses: github/codeql-action/autobuild@v3
 
-      # ℹ️ Command-line programs to run using the OS shell.
-      # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
 
-      #   If the Autobuild fails above, remove it and uncomment the following three lines.
-      #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
 
-      # - run: |
-      #   echo "Run, Build Application using script"
-      #   ./location_of_script_within_repo/buildscript.sh
+    #   If the Autobuild fails above, remove it and uncomment the following three lines.
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
 
-      - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v3
-        with:
-          category: "/language:${{matrix.language}}"
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2
+      with:
+        category: "/language:${{matrix.language}}"

.github/workflows/docs-cn.yml

@@ -2,41 +2,61 @@ name: Docs CN Mirror Deploy
 
 on:
   push:
-    branches: ["master"]
-    paths: ["docs/**"]
+    branches:
+      - master
+    paths:
+      - "docs/**"
 
 jobs:
   deploy:
+    if: github.repository == 'ArtalkJS/Artalk'
+
     runs-on: ubuntu-latest
 
+    defaults:
+      run:
+        # set for building docs
+        working-directory: ./docs
+
     steps:
-      - name: Checkout
-        uses: actions/checkout@v4
+    # - name: Wait for other docs build to succeed
+    #   uses: lewagon/wait-on-check-action@v1.2.0
+    #   with:
+    #     running-workflow-name: 'Docs CN Mirror Deploy'
+    #     check-name: 'Build Docs'
+    #     ref: ${{ github.ref }}
+    #     repo-token: ${{ secrets.GITHUB_TOKEN }}
+    #     allowed-conclusions: success,skipped,cancelled
+    #     wait-interval: 10
 
-      - name: Use pnpm
-        uses: pnpm/action-setup@v4
-        with:
-          version: 9.9.0
+    - name: Checkout
+      uses: actions/checkout@v3
 
-      - name: Setup node
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          cache: pnpm
+    - name: Use pnpm
+      uses: pnpm/action-setup@v2
+      with:
+        version: 8
 
-      - name: Install dependencies
-        run: pnpm install
+    - name: Setup node
+      uses: actions/setup-node@v3
+      with:
+        node-version: 18.x
+        registry-url: https://registry.npmjs.org/
+        cache: 'pnpm'
 
-      - name: Build Docs
-        run: pnpm build:docs
+    - name: Install dependencies
+      run: pnpm install
 
-      - name: Deploy
-        uses: TencentCloud/cos-action@v1
-        with:
-          secret_id: ${{ secrets.TENCENT_CLOUD_SECRET_ID }}
-          secret_key: ${{ secrets.TENCENT_CLOUD_SECRET_KEY }}
-          cos_bucket: ${{ secrets.DOCS_CN_COS_BUCKET }}
-          cos_region: ${{ secrets.DOCS_CN_COS_REGION }}
-          local_path: docs/docs/.vitepress/dist/
-          remote_path: /
-          clean: true
+    - name: Build Docs
+      run: pnpm docs:build
+
+    - name: Deploy
+      uses: TencentCloud/cos-action@v1
+      with:
+        secret_id: ${{ secrets.TENCENT_CLOUD_SECRET_ID }}
+        secret_key: ${{ secrets.TENCENT_CLOUD_SECRET_KEY }}
+        cos_bucket: ${{ secrets.DOCS_CN_COS_BUCKET }}
+        cos_region: ${{ secrets.DOCS_CN_COS_REGION }}
+        local_path: .vitepress/dist/
+        remote_path: /
+        clean: true

.github/workflows/release.yml

@@ -1,5 +1,5 @@
-name: 0x📦 Release New Version
-run-name: 📦 Release ${{ inputs.semver }} by @${{ github.actor }} ${{ inputs.dry_run && '(🧪 Dry-Run)' || '' }}
+name: 📦 Release New Version
+run-name: 📦 Release ${{ inputs.custom || inputs.semver }} by @${{ github.actor }}
 
 on:
   workflow_dispatch:
@@ -12,85 +12,82 @@ on:
           - minor
           - major
         required: true
-      custom_version:
-        description: Manual Custom Version (Special Purpose, v*)
-        type: string
-        required: false
-      dry_run:
-        description: "Dry run?"
-        type: boolean
-        default: false
+      # custom:
+      #   description: 'Custom tag name (i.e v1.0.0-rc.1)'
+      #   required: false
+      #   default: ''
+
+env:
+  REPO_DISPATCH_EVENT_TYPE: 'artalk-release'
+  UI_NPM_PKG_FILE: 'ui/packages/artalk/package.json'
 
 jobs:
   release:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v4
-        with:
-          ref: master
-          fetch-depth: 0
+        uses: actions/checkout@v3
+
+      - name: Git Fetch
+        run: git fetch --prune --unshallow --tags -f
 
       - name: Setup Node
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@v3
         with:
-          node-version: 20.x
+          node-version: 18.x
           registry-url: https://registry.npmjs.org/
 
-      - name: Setup semver
-        run: npm install -g semver
-
       - name: Handle Version Number
         run: |
-          PREV_VERSION="$(git describe --tags --abbrev=0 --match 'v*')"
-
-          if [ -n "${{ inputs.custom_version }}" ]; then
-            NEXT_VERSION="${{ inputs.custom_version }}"
+          if [ ! -z "${{ inputs.custom }}" ]; then
+            next_version="${{ inputs.custom }}"
           else
-            NEXT_VERSION="v$(semver --increment ${{ inputs.semver }} ${PREV_VERSION})"
+            npm install -g semver
+            prev_version="$(git describe --tags --abbrev=0)"
+            echo "prev_version: ${prev_version}"
+            next_version="v$(semver --increment ${{ inputs.semver }} ${prev_version})"
           fi
 
-          echo "PREV_VERSION=${PREV_VERSION}" >> $GITHUB_ENV
-          echo "VERSION=${NEXT_VERSION}" >> $GITHUB_ENV
+          if [[ ! "${next_version}" =~ ^v.* ]]; then
+            echo "[err] custom tag name must be v*."
+            exit 1
+          fi
 
-      - name: Print Next Version
-        run: echo "${VERSION}"
+          echo "next_version: ${next_version}"
+          echo "VERSION=${next_version}" >> $GITHUB_ENV
 
       - name: Setup git-chglog
         run: |
-          curl -sL $(curl -s https://api.github.com/repos/git-chglog/git-chglog/releases/latest \
-            | grep -oP '"https://.+linux_amd64.tar.gz"' | tr -d \") | tar -C /usr/local/bin -xz git-chglog
-          git-chglog --version
+            curl -sL $(curl -s https://api.github.com/repos/git-chglog/git-chglog/releases/latest \
+              | grep -oP '"https://.+linux_amd64.tar.gz"' | tr -d \") | tar -C /usr/local/bin -xz git-chglog
+            git-chglog --version
 
-      - name: Version Changelog
+      - name: Version Changelog and Tagging
         run: |
-          # prepend changelog
-          changelog=$(git-chglog --config .github/chglog/config.yml --next-tag "${VERSION}" "${VERSION}")
-          echo -e "${changelog}\n" | cat - CHANGELOG.md > temp && mv temp CHANGELOG.md
+          if [ ! $(git tag -l "${VERSION}") ]; then
+            # prepend changelog
+            changelog=$(git-chglog --config .github/chglog/config.yml --next-tag "${VERSION}" "${VERSION}")
+            echo -e "${changelog}\n" | cat - CHANGELOG.md > temp && mv temp CHANGELOG.md
 
-          # modify the version of `package.json`
-          perl -i -pe 's/"version": ".*?"/"version": "'${VERSION#v}'"/g' ui/artalk/package.json
+            # modify the version of `package.json`
+            perl -i -pe 's/"version": ".*?"/"version": "'${VERSION#v}'"/g' "${UI_NPM_PKG_FILE}"
 
-          # modify the version in docs
-          perl -pi -e 's#"latest"(\W+)?:(\W+)?".*?"#"latest": "'${VERSION#v}'"#g' docs/docs/code/ArtalkVersion.json
+            # modify the version in docs
+            perl -pi -e 's#"latest"(\W+)?:(\W+)?".*?"#"latest": "'${VERSION#v}'"#g' docs/code/ArtalkVersion.json
 
-      - name: Print Git Diff
-        run: git diff
+            # git commit and push
+            git config user.name github-actions[bot]
+            git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+            git add .
+            git commit -m "chore: release ${VERSION}"
+            git tag "${VERSION}"
 
-      - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v6
-        if: ${{ !inputs.dry_run }}
+            git push origin master "${VERSION}"
+          else
+            echo "skipped because git tag already exists."
+          fi
+
+      - name: Repository Dispatch
+        uses: peter-evans/repository-dispatch@v2
         with:
-          branch: "release/${{ env.VERSION }}"
-          commit-message: "chore: release ${{ env.VERSION }}"
-          title: "chore: release ${{ env.VERSION }}"
-          labels: release
-          body: |
-            ## Release ${{ env.VERSION }} 📦🚀
-
-            This PR is auto-generated, please check the changelog and confirm the release. 😀
-
-            The build workflow will be triggered after the PR is merged.
-          committer: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
-          author: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
-          assignees: ${{ github.actor }}
+          event-type: ${{ env.REPO_DISPATCH_EVENT_TYPE }}

.github/workflows/repo-dispatch.yml

@@ -8,13 +8,13 @@ on:
         type: string
         description: Event Type
         required: true
-        default: ""
+        default: ''
 
 jobs:
   release:
     runs-on: ubuntu-latest
     steps:
       - name: Repository Dispatch
-        uses: peter-evans/repository-dispatch@v3
+        uses: peter-evans/repository-dispatch@v2
         with:
           event-type: ${{ inputs.event_type }}

.github/workflows/test-docs.yml

@@ -1,38 +0,0 @@
-name: Test Docs
-
-on:
-  push:
-    branches: ["*", "!release/*", "!nightly"]
-    paths: ["docs/**"]
-    tags-ignore: ["v*"]
-  pull_request:
-    paths: ["docs/**"]
-    branches: ["*", "!release/*", "!nightly"]
-
-jobs:
-  test_docs:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Use pnpm
-        uses: pnpm/action-setup@v4
-        with:
-          version: 9.9.0
-
-      - name: Use Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20.x
-          cache: pnpm
-
-      - name: Install dependencies
-        run: pnpm install
-
-      - name: Build Docs
-        run: pnpm build:docs
-
-      - name: Lint Docs
-        run: pnpm eslint docs && pnpm prettier --check docs

.github/workflows/test-frontend.yml

@@ -2,12 +2,11 @@ name: Test Frontend
 
 on:
   push:
-    branches: ["*", "!release/*", "!nightly"]
-    paths: ["ui/**"]
-    tags-ignore: ["v*"]
+    paths:
+      - 'ui/**'
   pull_request:
-    paths: ["ui/**"]
-    branches: ["*", "!release/*", "!nightly"]
+    paths:
+      - 'ui/**'
 
 jobs:
   test_ui:
@@ -18,39 +17,31 @@ jobs:
 
     runs-on: ${{ matrix.os }}
 
+    defaults:
+      run:
+        working-directory: ./ui
+
     steps:
-      - if: matrix.os == 'windows-latest'
-        name: Set git to use LF (for Windows environment)
-        run: |
-          git config --global core.autocrlf false
-          git config --global core.eol lf
-
       - name: Checkout Code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v3
 
-      - uses: pnpm/action-setup@v4
+      - uses: pnpm/action-setup@v2
         with:
-          version: 9.9.0
+          version: 8
 
       - name: Use Node.js ${{ matrix.node }}
         uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
           cache: pnpm
+          cache-dependency-path: './ui/pnpm-lock.yaml'
 
       - name: Install Dependencies
-        run: pnpm install --frozen-lockfile
+        run: pnpm --dir ./ui install --frozen-lockfile
 
       - name: Package Build Test
         run: pnpm build:all
 
-      - name: Unit test
-        run: pnpm test
-
-      - name: Lint
-        run: pnpm eslint ui && pnpm prettier --check ui
-
-      # https://github.com/arethetypeswrong/arethetypeswrong.github.io
-      - name: "arethetypeswrong test"
-        if: runner.os == 'ubuntu-latest'
-        run: pnpm -F artalk test:attw || true
+      # TODO: Add unit test
+      # - name: Unit test
+      #   run: pnpm test

.goreleaser.yml

@@ -14,9 +14,9 @@ env:
 
 before:
   hooks:
-    # install dependencies
-    - make install
-    - make build-frontend
+  # install dependencies
+  - make install
+  - make build-frontend
 
 # build multi-platform
 builds:
@@ -60,7 +60,7 @@ builds:
     goarch:
       - arm
     goarm:
-      - "7"
+      - '7'
     env:
       - CC=arm-linux-gnueabihf-gcc
       - CXX=arm-linux-gnueabihf-g++
@@ -118,7 +118,7 @@ builds:
       # https://go-review.googlesource.com/c/go/+/224588/
       # https://github.com/ArtalkJS/Artalk/issues/35
       &win_common_flags |
-      -tags=timetzdata
+        -tags=timetzdata
 
   # Win (arm_64)
   - id: windows-arm64
@@ -156,7 +156,7 @@ archives:
       - artalk.yml
 
 checksum:
-  name_template: "checksums.txt"
+  name_template: 'checksums.txt'
 
 snapshot:
   name_template: "{{.Version}}-SNAPSHOT-{{.ShortCommit}}"
@@ -175,5 +175,3 @@ release:
     name: Artalk
   prerelease: auto
   draft: false
-  extra_files:
-    - glob: ./local/release_includes/*

.npmignore

@@ -1,57 +0,0 @@
-.DS_Store
-node_modules/
-
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-.pnpm-debug.log*
-
-.idea
-.vscode
-*.suo
-*.ntvs*
-*.njsproj
-*.sln
-.history
-.editorconfig
-
-# git
-.gitignore
-.gitattributes
-
-# tests
-test
-coverage
-
-# build tools
-.travis.yml
-.jenkins.yml
-.codeclimate.yml
-
-# linters
-.jscsrc
-.jshintrc
-.eslintrc*
-
-# vite configs
-vite*.config*
-
-# develop tool configs
-.prettierrc
-.eslintrc.js
-.eslintignore
-postcss.config.js
-
-yarn.lock
-package-lock.json
-
-# local files
-deploy
-local
-CNAME
-index.html
-#dist
-
-.github

.prettierignore

@@ -1,18 +0,0 @@
-CHANGELOG.md
-CHANGELOG.tpl.md
-CDN.html
-internal/template/notify_tpl/default.html
-
-# generated files
-# @link https://github.com/prettier/prettier/issues/3634
-pnpm-lock.yaml
-**/auto-imports.d.ts
-**/components.d.ts
-**/typed-router.d.ts
-ui/artalk/src/api/v2.ts
-docs/swagger/swagger.json
-docs/swagger/swagger.yaml
-docs/**
-ui/artalk-sidebar/src/lib/md5.js
-ui/artalk/src/lib/detect.ts
-**/dist/**

.prettierrc

@@ -1,26 +0,0 @@
-{
-  "arrowParens": "always",
-  "bracketSpacing": true,
-  "htmlWhitespaceSensitivity": "css",
-  "insertPragma": false,
-  "bracketSameLine": false,
-  "jsxSingleQuote": false,
-  "printWidth": 100,
-  "proseWrap": "preserve",
-  "quoteProps": "as-needed",
-  "requirePragma": false,
-  "semi": false,
-  "singleQuote": true,
-  "tabWidth": 2,
-  "trailingComma": "all",
-  "useTabs": false,
-  "vueIndentScriptAndStyle": false,
-  "overrides": [
-    {
-      "files": ["*.yaml", "*.yml"],
-      "options": {
-        "singleQuote": false
-      }
-    }
-  ]
-}

.vscode/launch.json

@@ -1,18 +1,14 @@
 {
-  "version": "0.2.0",
-  "configurations": [
-    {
-      "name": "Launch Artalk for Debugging",
-      "type": "go",
-      "request": "launch",
-      "mode": "exec",
-      "program": "${workspaceFolder}/bin/artalk",
-      "preLaunchTask": "Build for debugging",
-      "env": {
-        "ATK_SITE_DEFAULT": "ArtalkDocs",
-        "ATK_TRUSTED_DOMAINS": "http://localhost:5173 http://localhost:23367"
-      },
-      "args": ["server", "-c", "${workspaceFolder}/artalk.yml"]
-    }
-  ]
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Launch Artalk for Debugging",
+            "type": "go",
+            "request": "launch",
+            "mode": "exec",
+            "program": "${workspaceFolder}/bin/artalk",
+            "preLaunchTask": "Build for debugging",
+            "args": ["server", "-c", "${workspaceFolder}/data/artalk.yml"]
+        }
+    ],
 }

.vscode/settings.json

@@ -1,63 +1,20 @@
 {
-  // Enable the ESlint flat config support
-  "eslint.experimental.useFlatConfig": true,
-
-  // Disable the default formatter, use eslint instead
-  // "prettier.enable": false,
-  "editor.formatOnSave": false,
-
-  // Auto fix
-  "editor.codeActionsOnSave": {
-    "source.fixAll.eslint": "explicit",
-    "source.organizeImports": "never"
-  },
-
-  "eslint.runtime": "node",
-
-  // Silent the stylistic rules in you IDE, but still auto fix them
-  "eslint.rules.customizations": [
-    { "rule": "style/*", "severity": "off" },
-    { "rule": "*-indent", "severity": "off" },
-    { "rule": "*-spacing", "severity": "off" },
-    { "rule": "*-spaces", "severity": "off" },
-    { "rule": "*-order", "severity": "off" },
-    { "rule": "*-dangle", "severity": "off" },
-    { "rule": "*-newline", "severity": "off" },
-    { "rule": "*quotes", "severity": "off" },
-    { "rule": "*semi", "severity": "off" }
-  ],
-
-  // Enable eslint for all supported languages
-  "eslint.validate": [
-    "javascript",
-    "javascriptreact",
-    "typescript",
-    "typescriptreact",
-    "vue",
-    "html",
-    "markdown",
-    "json",
-    "jsonc",
-    "yaml",
-    "toml",
-    "xml"
-  ],
-
-  "cSpell.words": [
-    "akismet",
-    "artalk",
-    "artran",
-    "artrans",
-    "artransfer",
-    "gomail",
-    "Goreleaser",
-    "gorm",
-    "ldflags",
-    "lfshook",
-    "Metas",
-    "pgsql",
-    "sendmail",
-    "sqlite",
-    "pkged"
-  ]
+    "eslint.workingDirectories": ["./ui"],
+    "cSpell.words": [
+        "akismet",
+        "artalk",
+        "artran",
+        "artrans",
+        "artransfer",
+        "gomail",
+        "Goreleaser",
+        "gorm",
+        "ldflags",
+        "lfshook",
+        "Metas",
+        "pgsql",
+        "sendmail",
+        "sqlite",
+        "pkged"
+    ]
 }

.vscode/tasks.json

@@ -1,14 +1,14 @@
 {
-  "version": "2.0.0",
-  "tasks": [
-    {
-      "label": "Build for debugging",
-      "type": "shell",
-      "command": "make build-debug",
-      "group": {
-        "kind": "build",
-        "isDefault": true
-      }
-    }
-  ]
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "Build for debugging",
+            "type": "shell",
+            "command": "make build-debug",
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            }
+        }
+    ]
 }

CHANGELOG.md

@@ -1,382 +1,4 @@
 
-## [v2.9.0](https://github.com/ArtalkJS/Artalk/compare/v2.8.7...v2.9.0) (2024-09-03)
-
-### Features
-
-* **auth:** add user profile and password changing ([#966](https://github.com/ArtalkJS/Artalk/issues/966))
-* **config:** add `site_url` config option ([#967](https://github.com/ArtalkJS/Artalk/issues/967))
-* **go:** upgrade golang to v1.22.6 and some deps
-* **ui/dashboard:** new dashboard ui refresh for desktop devices ([#957](https://github.com/ArtalkJS/Artalk/issues/957))
-* **ui/date:** add `dateFormatter` config option ([#940](https://github.com/ArtalkJS/Artalk/issues/940))
-* **ui/plugin:** make ui plugin configurable
-* **ui/sidebar:** add dark mode toggle for dashboard ([#790](https://github.com/ArtalkJS/Artalk/issues/790))
-* **ui/sidebar:** add page search by keywords in sidebar ([#603](https://github.com/ArtalkJS/Artalk/issues/603))
-* **ui/sidebar:** add user search by keywords in sidebar ([#710](https://github.com/ArtalkJS/Artalk/issues/710))
-
-### Bug Fixes
-
-* **anti_spam:** handle empty `referer` variable in anti-spam check ([#853](https://github.com/ArtalkJS/Artalk/issues/853))
-* **api/auth:** fix missing Microsoft oauth provider configuration ([#929](https://github.com/ArtalkJS/Artalk/issues/929))
-* **api/auth:** migrate auth_identities when account merging ([#920](https://github.com/ArtalkJS/Artalk/issues/920))
-* **api/auth:** register issue due to unremoved auth records after user deletion ([#919](https://github.com/ArtalkJS/Artalk/issues/919))
-* **api/comment_add:** improve the security of comment add api ([#964](https://github.com/ArtalkJS/Artalk/issues/964))
-* **auth:** correct email verification code send button
-* **plugin/lightbox:** fix import for non-browser env ([#931](https://github.com/ArtalkJS/Artalk/issues/931))
-* **plugin_kit:** fix typescript lib path retrieval on win
-* **plugin_kit:** import source path case error on linux
-* **sidebar:** correct total item count for pagination in sidebar
-* **ui/dark_mode:** apply dark mode config option before mounting ui ([#890](https://github.com/ArtalkJS/Artalk/issues/890))
-* **ui/plugin-kit:** fix typescript lib folder for api-extractor in monorepo
-* **ui/sidebar:** disable admin password check dialog in sidebar
-* **ui/sidebar:** show env variables in sidebar settings ui ([#946](https://github.com/ArtalkJS/Artalk/issues/946)) ([#956](https://github.com/ArtalkJS/Artalk/issues/956))
-* **ui/stat:** fix invalid backward compatible strategy ([#880](https://github.com/ArtalkJS/Artalk/issues/880))
-* **validator:** restrict to allow only HTTP protocol
-
-### Performance Improvements
-
-* **api/auth:** add more specific error messages for login failures
-* **app/init:** generate translated config file by env variable `ATK_LOCALE`
-* **auth:** add loading skeleton for login methods list
-* **auth:** enhance visibility of skip button ([#863](https://github.com/ArtalkJS/Artalk/issues/863))
-* **auth:** perform optical adjustment for consistent icon sizing
-* **auth:** correct verify button position in register form
-* **i18n:** auto-load frontend i18n locale js sources
-* **notify:** improve error messages for notify ([#943](https://github.com/ArtalkJS/Artalk/issues/943))
-* **plugin_kit:** improve typescript diagnostics output
-* **style/sidebar:** modify font-family for sidebar
-* **ui/sidebar:** enhance i18n translations for sidebar
-* **ui/sidebar:** mask sensitive input values in sidebar settings ([#494](https://github.com/ArtalkJS/Artalk/issues/494))
-* **ui/sidebar:** optimize setup process and i18n lazy load ([#962](https://github.com/ArtalkJS/Artalk/issues/962))
-
-### Code Refactoring
-
-* **plugin_katex:** use tokenizer extension of marked ([#955](https://github.com/ArtalkJS/Artalk/issues/955))
-* **ui/deps:** remove `abortcontroller-polyfill` ([#923](https://github.com/ArtalkJS/Artalk/issues/923))
-* **ui/marked:** replace pkg-level marked with new class instance ([#954](https://github.com/ArtalkJS/Artalk/issues/954))
-* **ui/types:** add `Layer` interface
-* **ui/user:** rename `nick` to `name` in `LocalUser` data structure ([#961](https://github.com/ArtalkJS/Artalk/issues/961))
-
-### Documentation
-
-* **auth:** set `auth.anonymous` to false as default
-* **ui/i18n:** add more locale support for sidebar
-* **ui/i18n:** add translations for French, Korean, and Russian
-
-
-## [v2.8.7](https://github.com/ArtalkJS/Artalk/compare/v2.8.6...v2.8.7) (2024-06-09)
-
-### Features
-
-* **go:** upgrade golang to v1.22.3 and some deps
-* **plugin_kit:** add vite plugin for developing artalk plugins ([#904](https://github.com/ArtalkJS/Artalk/issues/904))
-* **sync:** add keyed rw-mutex
-
-### Bug Fixes
-
-* **api/auth:** include render mustache params for verification email subject ([#910](https://github.com/ArtalkJS/Artalk/issues/910))
-* **api/stats:** fix `site_pv` response body and add unit tests ([#896](https://github.com/ArtalkJS/Artalk/issues/896))
-* **api/transfer_upload:** close temp file in transfer upload endpoint ([#877](https://github.com/ArtalkJS/Artalk/issues/877))
-* **auth:** failed to register by social account on mysql database ([#902](https://github.com/ArtalkJS/Artalk/issues/902))
-* **conf_env:** enhance environment variable loading for config ([#892](https://github.com/ArtalkJS/Artalk/issues/892))
-* **plugin_katex:** fix event issue causing katex integration failure ([#897](https://github.com/ArtalkJS/Artalk/issues/897))
-* **ui/height_limit:** height limit issue for collapsed comments ([#865](https://github.com/ArtalkJS/Artalk/issues/865))
-* **ui/sidebar:** unable to logout if user is not admin in control center
-* **ui/types:** remove marked dependency in dts ([#868](https://github.com/ArtalkJS/Artalk/issues/868))
-
-### Performance Improvements
-
-* **conf:** add cache for config metadata to boost startup speed ([#892](https://github.com/ArtalkJS/Artalk/issues/892))
-* **dao:** add singleflight for no-cache db find func
-* **gravatar:** support both sha256 and md5 hash for gravatar ([#912](https://github.com/ArtalkJS/Artalk/issues/912))
-* **gravatar:** convert email to lowercase before hashing for gravatar
-* **gravatar:** use sha256 hashing algorithm for gravatar ([#874](https://github.com/ArtalkJS/Artalk/issues/874))
-* **ui/conf:** exclude conf `pvEl`, `countEl` and `statPageKeyAttr` from remove server ([#905](https://github.com/ArtalkJS/Artalk/issues/905))
-* **ui/dev:** bump eslint to v9 ([#915](https://github.com/ArtalkJS/Artalk/issues/915))
-
-### Code Refactoring
-
-* **dao:** add `date` field to the page json entity
-* **dao:** improve `QueryDBWithCache` func and concurrent unit tests ([#884](https://github.com/ArtalkJS/Artalk/issues/884))
-* **transfer:** improve the reliability of the transfer ([#883](https://github.com/ArtalkJS/Artalk/issues/883))
-* **transfer:** strip domain from page key by default ([#873](https://github.com/ArtalkJS/Artalk/issues/873))
-* **ui:** fix linter issues for ui and docs ([#917](https://github.com/ArtalkJS/Artalk/issues/917))
-* **ui/stat:** use class selector for pageview elements by default ([#880](https://github.com/ArtalkJS/Artalk/issues/880))
-
-### Documentation
-
-* refine documentation
-* **dev:** refine contributing.md and translate to chinese
-* **i18n:** revise French translation ([#913](https://github.com/ArtalkJS/Artalk/issues/913))
-* **ip_region:** add instructions for obtaining accurate IP under proxy
-
-
-## [v2.8.6](https://github.com/ArtalkJS/Artalk/compare/v2.8.5...v2.8.6) (2024-05-09)
-
-### Features
-
-* **auth:** user accounts merge tool ([#854](https://github.com/ArtalkJS/Artalk/issues/854))
-* **auth:** social login api endpoints ([#854](https://github.com/ArtalkJS/Artalk/issues/854))
-* **ci:** include frontend dist files in release ([#860](https://github.com/ArtalkJS/Artalk/issues/860))
-* **i18n:** add incremental updates feature for i18n code scan tool
-* **multi_push/lark:** add card mode for lark push ([#839](https://github.com/ArtalkJS/Artalk/issues/839))
-* **sync:** add keyed mutex
-* **ui/auth:** plugin-auth for integrating social login ([#854](https://github.com/ArtalkJS/Artalk/issues/854))
-* **ui/img_lazyload:** add support for lazy loading images ([#850](https://github.com/ArtalkJS/Artalk/issues/850))
-
-### Bug Fixes
-
-* **api/pv:** add mutex for page pv record endpoint
-* **cache/user:** user id cache from email lookup not cleared
-* **comments_get:** include `site_name` for isolation in associated query for comment's page
-* **dao:** ensure find and create functions thread safe ([#845](https://github.com/ArtalkJS/Artalk/issues/845))
-* **db/migrate:** fix root_id migrate for database lacking recursive CTE support ([#848](https://github.com/ArtalkJS/Artalk/issues/848)) ([#846](https://github.com/ArtalkJS/Artalk/issues/846))
-* **db_migrate:** drop `fk_comments_user` foreign key constraint of the users table
-* **sidebar/site:** unable to edit the new site urls
-* **ui/dark_mode:** add support for configuring dark mode in backend ([#790](https://github.com/ArtalkJS/Artalk/issues/790))
-* **ui/dark_mode:** unable to toggle dark mode for sidebar in auto mode
-* **ui/height_limit:** height limit not working while loading images ([#849](https://github.com/ArtalkJS/Artalk/issues/849))
-* **ui/marked:** optimize same origin link judgment logic
-
-### Documentation
-
-* update introduction document
-* **auth:** add social login feature ([#854](https://github.com/ArtalkJS/Artalk/issues/854))
-* **i18n:** add translation for Korean and Russian
-
-
-## [v2.8.5](https://github.com/ArtalkJS/Artalk/compare/v2.8.3...v2.8.5) (2024-04-21)
-
-### Features
-
-* **ci/build:** add nightly build workflow
-* **conf/http:** add `http.proxy_header` config option
-* **go:** upgrade golang to v1.22.2 and some deps
-
-### Bug Fixes
-
-* **cmd/gen:** ensure directory before saving in `gen` cmd ([#612](https://github.com/ArtalkJS/Artalk/issues/612))
-* **dao:** prevent potential infinite loop in `FindCommentRootID`
-* **db/migrate:** issue with root id generation
-* **db/migrator:** remove foreign key constraints and better `root_id` generation ([#835](https://github.com/ArtalkJS/Artalk/issues/835))
-* **log:** improve log system and fix memory leaks ([#843](https://github.com/ArtalkJS/Artalk/issues/843))
-* **transfer:** retrieve root_id for imported comment data
-* **ui/comment:** missing reply comment data when inserting ([#838](https://github.com/ArtalkJS/Artalk/issues/838))
-* **ui/comment:** incorrect reply comment data in nested mode ([#771](https://github.com/ArtalkJS/Artalk/issues/771)) ([#837](https://github.com/ArtalkJS/Artalk/issues/837))
-* **ui/lifecycle:** keep root element during destroy ([#810](https://github.com/ArtalkJS/Artalk/issues/810))
-* **ui/sidebar:** user list not refresh when data is modified
-* **ui/upload:** unable to upload image when file extension is uppercase
-* **upload:** add config option to solve request entity too large issue ([#834](https://github.com/ArtalkJS/Artalk/issues/834))
-
-### Performance Improvements
-
-* **conf/upgit:** disallow custom executable path of `upgit` for security ([#817](https://github.com/ArtalkJS/Artalk/issues/817))
-* **db:** optimize N+1 query in comment list ([#799](https://github.com/ArtalkJS/Artalk/issues/799))
-* **i18n:** add translation for 'parameter is required'
-* **ui/pkg:** add shorter export names ([#821](https://github.com/ArtalkJS/Artalk/issues/821))
-* **ui/version_check:** beautify version upgrade notice
-
-### Code Refactoring
-
-* **comments_get:** reduce api complexity by introducing `LiteDB` ([#800](https://github.com/ArtalkJS/Artalk/issues/800))
-* **ui/prettier:** add prettier code formatter
-
-### Documentation
-
-* **extras:** add deploy guide for Valaxy ([#836](https://github.com/ArtalkJS/Artalk/issues/836))
-* **i18n:** add French translation ([#797](https://github.com/ArtalkJS/Artalk/issues/797))
-
-### BREAKING CHANGE
-
-
-For UpGit users: Due to security reasons, Artalk no longer allows configuring the executable file path (img_upload.upgit.exec) for upgit. Please add it to system environment variables instead.
-
-
-## [v2.8.3](https://github.com/ArtalkJS/Artalk/compare/v2.8.2...v2.8.3) (2024-03-04)
-
-### Features
-
-* **api/auth:** invalidate old auth tokens after changing password
-* **api/domain:** add GET `/conf/domain` endpoint
-* **app:** add `onConfUpdated` hook
-* **comment:** add `is_verified` field for comment entity
-* **ui/api:** add `ctx.getApiHandlers()` to handle error responses and expose hooks
-* **ui/editor:** add `beforeSubmit` hook for editor submitting
-* **ui/plugins:** support dynamic loading of ui plug-in scripts ([#774](https://github.com/ArtalkJS/Artalk/issues/774))
-
-### Bug Fixes
-
-* **captcha/image:** unable to display image captcha on initial load
-* **conf:** skip patching IP region conf if disabled
-* **exception:** missing `message` field after refactoring exception data structure
-* **sidebar/login:** cannot select a name with the same email upon login ([#781](https://github.com/ArtalkJS/Artalk/issues/781))
-* **ui/layer:** ensure immediate operation when calling `show()` after `hide()`
-
-### Performance Improvements
-
-* **ui/editor:** improve the icon details for editor
-
-### Code Refactoring
-
-* **dao:** validate the args of the `FindCreateUser` function
-* **entity/user:** extract `CheckPassword` function
-* **origin:** extract `CheckURLTrusted` function
-
-
-## [v2.8.2](https://github.com/ArtalkJS/Artalk/compare/v2.8.1...v2.8.2) (2024-02-05)
-
-### Bug Fixes
-
-* **api/comments:** `ua` field is optional and not required ([#767](https://github.com/ArtalkJS/Artalk/issues/767))
-* **style:** replace style `break-all` with `break-word` in content el ([#644](https://github.com/ArtalkJS/Artalk/issues/644))
-
-### Performance Improvements
-
-* **ui/editor:** optimize editor styles for narrow-width screens
-* **ui/editor:** modify editor plug-in text buttons to icons for brevity
-* **ui/editor:** place `Cancel Reply` at the bottom of editor area ([#644](https://github.com/ArtalkJS/Artalk/issues/644))
-* **ui/lite:** disable ArtalkLite `preview` config option by default
-
-
-## [v2.8.1](https://github.com/ArtalkJS/Artalk/compare/v2.8.0...v2.8.1) (2024-02-04)
-
-### Features
-
-* **api:** add GET `/comments/:id` endpoint ([#764](https://github.com/ArtalkJS/Artalk/issues/764))
-* **config:** add `db.prepare_stmt` config option ([#760](https://github.com/ArtalkJS/Artalk/issues/760)) ([#762](https://github.com/ArtalkJS/Artalk/issues/762))
-* **ui/goto:** improved solution of navigating to comment via link hash ([#693](https://github.com/ArtalkJS/Artalk/issues/693)) ([#765](https://github.com/ArtalkJS/Artalk/issues/765))
-
-### Bug Fixes
-
-* **api/comments:** counting comments issue in PostgreSQL db ([#760](https://github.com/ArtalkJS/Artalk/issues/760)) ([#761](https://github.com/ArtalkJS/Artalk/issues/761))
-* **cmd/admin:** update user role to admin if already exists
-* **ip_region:** unable to output the IP region correctly ([#760](https://github.com/ArtalkJS/Artalk/issues/760))
-* **ui/list:** unable to reply or delete comments after switching pagination
-* **ui/no_comment:** always appears when creating comment
-* **ui/pv:** missing `pageTitle` field in the PV request
-* **ui/scroll:** scroll into view issue when `relativeTo` parameter is provided
-
-### Performance Improvements
-
-* **style/sidebar:** improve some detail in sidebar
-
-### Code Refactoring
-
-* **ui/comment:** loose coupling between `Comment` and `Context`
-* **ui/list:** refactor the list layout manager
-
-### Documentation
-
-* supplement and refine `fe-api.md`
-
-
-## [v2.8.0](https://github.com/ArtalkJS/Artalk/compare/v2.7.3...v2.8.0) (2024-01-31)
-
-### Features
-
-* **go:** upgrade golang to v1.21.5 and some deps
-* **notify:** add `notify_pending` config option ([#728](https://github.com/ArtalkJS/Artalk/issues/728)) ([#754](https://github.com/ArtalkJS/Artalk/issues/754))
-* **ui/admin:** add logout button in admin panel ([#488](https://github.com/ArtalkJS/Artalk/issues/488)) ([#753](https://github.com/ArtalkJS/Artalk/issues/753))
-
-### Bug Fixes
-
-* **cache:** unable to change admin list after caching ([#748](https://github.com/ArtalkJS/Artalk/issues/748)) ([#750](https://github.com/ArtalkJS/Artalk/issues/750))
-* **i18n:** sidebar language cannot be changed
-* **ui/editor:** prevent propagation of click event in editor ([#734](https://github.com/ArtalkJS/Artalk/issues/734))
-* **ui/layer:** unexpected behavior with multiple items when closing
-* **ui/lite:** correct the instance name for compiling ArtalkLite ([#740](https://github.com/ArtalkJS/Artalk/issues/740))
-* **ui/no_comment:** flickering when clearing list before fetch
-* **ui/pagination:** auto load list when scroll reaches bottom
-* **ui/sidebar:** incorrectly increasing pv count in sidebar ([#724](https://github.com/ArtalkJS/Artalk/issues/724))
-* **ui/sidebar_layer:** sidebar still displays when login is required
-
-### Performance Improvements
-
-* **ui/conf:** support for watching partial changes in config with `watchConf()` ([#755](https://github.com/ArtalkJS/Artalk/issues/755))
-* **ui/i18n:** refine some translation ([#743](https://github.com/ArtalkJS/Artalk/issues/743))
-* **ui/pagination:** replace the prev/next text on pagination buttons with icons ([#743](https://github.com/ArtalkJS/Artalk/issues/743))
-* **ui/sidebar:** prevent potential token leakage by clearing query in iframe url
-
-### Code Refactoring
-
-* **api:** update swagger file of API v2
-* **api:** refactor HTTP API to version 2 ([#735](https://github.com/ArtalkJS/Artalk/issues/735))
-* **transfer:** normalize transfer payload parameter name
-* **ui:** optimize init and update lifecycle events
-* **ui/comment:** rename class `Comment` to `CommentNode`
-* **ui/ctx:** add `getComments` and `getCommentNodes` in context ([#752](https://github.com/ArtalkJS/Artalk/issues/752))
-
-### Documentation
-
-* update multi-sites manual ([#747](https://github.com/ArtalkJS/Artalk/issues/747))
-
-### BREAKING CHANGE
-
-
-For Developers: The HTTP API has now been updated to version v2, with a lot of adjustments made, such as changing to Restful API style, request type, request body, response body, etc. data structure, adding error response codes. You can refer to [#735](https://github.com/ArtalkJS/Artalk/issues/735) or https://artalk.js.org/http-api Please update all your existing clients to adapt to the new v2 server. The new base path is `/api/v2/`. The UI package's HTTP client has been implemented to auto-generate based on `Swagger.json`, and there have been a lot of adjustments to the `artalk.ctx.getApi()` related code. In addition, the HTTP API no longer enforces checks on the header's `Origin` and `Referer` (to implement strict isolation of different sites) but still maintains the original CORS origin check.
-
-For General Users: Now all administrators have the same level of authority (there is no longer super admin authority), the function of assigning sub-administrators with independent scope authority to individual sites has been removed, which can simplify the HTTP server maintenance and implementation. Upgrading only requires updating the client and server application at the same time, and there are no additional operations.
-
-
-## [v2.7.3](https://github.com/ArtalkJS/Artalk/compare/v2.7.2...v2.7.3) (2023-12-28)
-
-### Features
-
-* **ci:** add dry-run mode for build workflow
-* **cmd:** support cli flag for creating admin account
-
-### Bug Fixes
-
-* **ui/init:** stack overflow when merging with config defaults ([#717](https://github.com/ArtalkJS/Artalk/issues/717))
-
-### Performance Improvements
-
-* **ui/build:** better dts generation ([#689](https://github.com/ArtalkJS/Artalk/issues/689))
-
-### Code Refactoring
-
-* **ci:** better release workflow
-* **docker:** add `--build-arg` argument to skip ui build
-* **test/ui:** add more ui api tests
-* **ui:** refactor directory structure ([#712](https://github.com/ArtalkJS/Artalk/issues/712))
-* **ui/conf:** better handling of mutable config ([#722](https://github.com/ArtalkJS/Artalk/issues/722))
-* **ui/test:** add vitest for unit testing
-
-### Documentation
-
-* update ui api documentation
-
-### BREAKING CHANGE
-
-
-Directly referencing `artalk.conf` and `artalk.$root` is deprecated. Please use functions instead: `artalk.getConf()` and `artalk.getEl()`.
-
-
-## [v2.7.2](https://github.com/ArtalkJS/Artalk/compare/v2.7.1...v2.7.2) (2023-12-20)
-
-### Features
-
-* patch `locale` config from `zh-cn` to `zh-CN` ([#678](https://github.com/ArtalkJS/Artalk/issues/678))
-
-### Bug Fixes
-
-* **sidebar:** sidebar language switch and config save issue ([#708](https://github.com/ArtalkJS/Artalk/issues/708))
-* **ui:** add `referrerpolicy` attribute for iframe ([#687](https://github.com/ArtalkJS/Artalk/issues/687)) ([#707](https://github.com/ArtalkJS/Artalk/issues/707))
-* **ui/dark-mode:** potential memory leak issue in auto mode ([#688](https://github.com/ArtalkJS/Artalk/issues/688))
-* **ui/pagination:** auto switch page by url hashtag issue ([#693](https://github.com/ArtalkJS/Artalk/issues/693))
-* **ui/sidebar:** refactor settings and fix save issue ([#677](https://github.com/ArtalkJS/Artalk/issues/677)) ([#706](https://github.com/ArtalkJS/Artalk/issues/706))
-
-### Code Refactoring
-
-* **ui:** move window references into function scope ([#675](https://github.com/ArtalkJS/Artalk/issues/675))
-* **ui/api:** losing coupling between `Api` and `User`
-* **ui/user:** user class no longer globally singleton
-
-### Documentation
-
-* **i18n:** add translation for `open` button
-* **refactor:** organize the pkgs and fix some issues ([#702](https://github.com/ArtalkJS/Artalk/issues/702))
-
-
 ## [v2.7.1](https://github.com/ArtalkJS/Artalk/compare/v2.7.0...v2.7.1) (2023-12-17)
 
 ### Bug Fixes

CONTRIBUTING.md

@@ -1,298 +1,126 @@
 # Developer Contributing Guide
 
-This guide helps developers understand how to contribute code, documentation, tests, and feedback to the Artalk project. We welcome all forms of contributions, whether it's large feature development, small fixes, documentation improvements, or testing. We believe that every contribution is an important part of moving the project forward.
+This guide is for developers who want to contribute to the project.
 
-This guide is available in multiple languages: [English](https://github.com/ArtalkJS/Artalk/blob/master/CONTRIBUTING.md) • [简体中文](https://artalk.js.org/develop/contributing.html)
+## Development Environment
 
-## Setup
+To develop Artalk, including the frontend and backend, you need to install the following tools:
 
-Clone the repository:
+- [Node.js](https://nodejs.org/en/) (>= 18.12.0)
+- [Go](https://golang.org/) (>= 1.21)
+- [Docker](https://www.docker.com/) (>= 20.10.0) (optional)
+- [Docker Compose](https://docs.docker.com/compose/) (>= 1.29.0) (optional)
+
+Then we'll setup the development environment.
+
+### Get the source code
+
+Run the following command to clone the repository:
 
 ```sh
-git clone https://github.com/ArtalkJS/Artalk.git
+git clone https://github.com/ArtalkJS/Artalk
 ```
 
-It's recommended to fork the repository first, and then clone the forked repository.
+It is recommended to fork the repository first, and then clone the forked repository.
 
-Navigate to the directory:
+Enter the directory:
 
 ```sh
 cd Artalk
 ```
 
-## Development Environment
-
-To develop Artalk, both frontend and backend, install the following tools:
-
-- [Node.js](https://nodejs.org/en/) (>= 20.17.0)
-- [PNPM](https://pnpm.io/) (>= 9.9.0)
-- [Go](https://golang.org/) (>= 1.22)
-- [Docker](https://www.docker.com/) (>= 20.10.0) (optional)
-- [Docker Compose](https://docs.docker.com/compose/) (>= 1.29.0) (optional)
-
-## Development Workflow Overview
-
-The development workflow consists of the following steps:
-
-1. **Set Up Complete Development Instance**:
-
-   - Navigate to the Artalk Repo directory.
-   - Execute `make dev` to run the backend on port `23366`.
-   - Execute `pnpm dev` to run the frontend on port `5173`.
-   - Optionally, execute `pnpm dev:sidebar` to run the sidebar frontend on port `23367`.
-
-2. **Access Frontend for Development**:
-
-   - Open your browser and go to `http://localhost:5173` to perform your development and testing.
-
-3. **Testing**:
-
-   - Run the backend unit tests using `make test`.
-   - Run the ui unit tests using `pnpm test`.
-   - Run the ui E2E tests using `make test-frontend-e2e`.
-
-4. **Building Frontend Code**:
-
-   - When you make changes to the frontend code, build the complete frontend program using `pnpm build:all`.
-   - The JavaScript and CSS code will be found in `ui/artalk/dist`.
-   - The frontend code is automatically deployed to NPM by GitHub Actions.
-
-5. **Building Backend Code**:
-
-   - When you make changes to the backend code, note that the backend program embeds the frontend code.
-   - Before building the backend, run `make build-frontend` (which runs `scripts/build-frontend.sh`). This will place the embedded frontend main program and sidebar frontend program in `/public`.
-   - Then, build the backend program using `make build`.
-
-More exploration:
-
-- **Developing Artalk Plugins or Themes**:
-  Refer to the [Artalk Plugin Development Guide](https://artalk.js.org/develop/plugin.html).
-
-- **Makefile**:
-  You can explore the process and commands in the `Makefile`.
-
-- **Automated CI on GitHub**:
-  The automated CI pipeline on GitHub, located in the `.github/workflows` directory, builds the frontend, backend, and Docker images. It publishes Docker images to Docker Hub, handles npm package publishing, and creates GitHub Releases. And also testing the frontend and backend.
-
-The following sections provide more detailed information on the development workflow.
-
-## Project Structure
-
-Artalk is a monorepo project, meaning all the source code resides in a single repository. Despite this, the frontend and backend are kept separate. The frontend part is located in the `./ui` directory.
-
-### Directory Overview
-
-- `bin/`: The compiled binary files. (This directory is ignored by git).
-- `cmd/`: The source code for the command line tools.
-- `conf/`: The sample configuration files.
-- `data/`: The local data. (This directory is ignored by git).
-- `docs/`: The documentation site source code.
-- `i18n/`: The translation files.
-- `local/`: The local files. (This directory is ignored by git).
-- `internal/`: The Go source code for the internal packages.
-- `public/`: The static files. Built frontend files will be copied here.
-- `scripts/`: The scripts for development and building.
-- `server/`: The Go source code for the backend.
-- `ui/`: The UI source code for the frontend.
-- `.github/`: The GitHub Actions workflows.
-- `.vscode/`: The VSCode settings.
-
-## Backend Development
-
-### Run Backend
-
-1. **Create Configuration File**:
-
-   - Copy `./conf/artalk.example.yml` to the root directory.
-   - Rename it to `artalk.yml`.
-   - Modify the file as needed.
-
-2. **Start Backend Program**:
-
-   - Run `make dev` to start the backend on port `23366`.
-   - Access it via `http://localhost:23366`.
-   - It's recommended to keep the default port for testing.
-   - (Alternative) Use `ARGS="version" make dev` to pass startup parameters (default is `ARGS="server"`).
-
-The `make dev` builds the backend with debugging symbols, which is convenient for debugging with GDB.
-
-If you are using the VSCode, you can use the `F5` key (or RUN button) to start debugging the backend program directly.
-
 ### Build Backend
 
-1. **Fetch Latest Git Tag**:
-   Execute `git fetch --tags` to get the latest git tag information. This tag will be used as the version number of the backend app. Alternatively, specify it using environment variables: `VERSION="v1.0.0"` and `COMMIT_HASH="66128e"`.
+First, you need to install the dependencies for the backend written in Go. Simply run the `make install` command to install the dependencies.
 
-2. **Build Frontend**:
-   Run `make build-fronted` to build the frontend, as the backend app embeds the frontend code.
+Then, run the `make dev` to build and run `./bin/artalk`, and you can pass startup parameters to the program using `ARGS="version" make dev`.
 
-3. **Build Backend**:
-   Execute `make build` to build the backend program.
+This will build the backend with debugging symbols. The binary file will be placed under the `./bin` directory.
 
-The built binary file will be located in the `./bin` directory.
-
-## Frontend Development (UI)
-
-### Run Frontend
-
-1. **Install Dependencies**:  
-   Run `pnpm install` to install all necessary dependencies.
-
-2. **Start Development Server**:  
-   Execute `pnpm dev --port 5173` to start the frontend development server.
-
-3. **Access the Frontend**:  
-   The frontend application will run on port `5173` by default. Access it in your browser at `http://localhost:5173`.
-
-4. **Sidebar Development**:  
-   To run the sidebar part of the frontend, use `pnpm dev:sidebar`.
-
-The ports `5173` and `23367` are used for frontend development and testing. These ports are included in the `ATK_TRUSTED_DOMAINS` configuration of the backend program.
+The backend program will run by default on port `23366`. You can access it through a browser at `http://localhost:23366`. It's recommended not to change this port number for testing the backend program.
 
 ### Build Frontend
 
-To build the frontend, run the following command:
+First, you need to install the dependencies for the frontend. Simply run the `cd ui && pnpm install` command to install the dependencies.
+
+Then, run the `cd ui && pnpm dev` to build and run the frontend, and you can pass startup parameters to the program using `ARGS="--port 5173" pnpm dev`.
+
+The frontend program will run by default on port `5173`, and you can access it in a browser at `http://localhost:5173`. The frontend testing client will, by default, request the backend on port `23366`, so it's essential to keep the backend on this port.
+
+The frontend program is divided into the main program and a sidebar program, with the sidebar program running on a separate port, which is `23367`.
+
+### Development Workflow
+
+In most cases, to set up a complete development instance, you need to navigate to the Artalk Repo directory and then execute `make dev`. This will run the backend on port `23366`. Then, execute `cd ui && pnpm dev`, which will run the frontend on port `5173`. You can optionally execute `pnpm dev:sidebar` to run the sidebar frontend on port `23367`. For frontend development, you need to access `http://localhost:5173` in your browser to perform your development and testing.
+
+When you make changes to the frontend code, you can build the complete frontend program using `cd ui && pnpm build:all`. The JavaScript and CSS code can be found in `ui/packages/artalk/dist`.
+
+When you make changes to the backend code, running `make all` will build the complete backend program. Note that since the backend program also embeds the frontend code, the `scripts/build-frontend.sh` script will run during backend program building, which includes the embedded frontend main program and sidebar frontend program. If you are interested, you can explore the complete frontend build process in the `Makefile` code.
+
+Additionally, there is automated CI on GitHub for building. You can find the relevant code in the `.github/workflows` directory.
+
+### Optional: Use a One-Key Script to Run a Demo Site
+
+When you access `http://localhost:5173` during frontend development, you will get a minimalist interface that only contains the Artalk program interface and not a real blog environment. If you want to make testing closer to a real environment, you can create a demo blog site using the following steps.
+
+Run the following command:
 
 ```sh
-make build-frontend
+./scripts/setup-example-site.sh
 ```
 
-The compiled JavaScript and CSS files will be located in the `/public` directory, embedded into the backend program.
+This script sets up a local example site for testing at `data` folder, with Artalk integrated into its theme.
 
-For more details, refer to the `scripts/build-frontend.sh` script.
-
-## Docker Development
-
-### Build Docker Image
-
-To build the Docker image, run the following command:
+After running this script, run:
 
 ```sh
-docker build -t artalk:TAG .
+./bin/artalk server -c ./data/artalk.yml
 ```
 
-Replace `TAG` with the desired tag name (e.g., `latest`).
+to start the artalk server.
 
-### Skip Frontend Build
+And open <http://localhost:1313/> in your browser to view the example site.
 
-If you have already built the frontend outside the Docker container, you can skip the frontend build process inside the container to speed up the build. Use the following command:
+Here is the default admin account (only created in test mode):
 
-```sh
-docker build --build-arg SKIP_FRONTEND_BUILD=true -t artalk:latest .
+```yaml
+name: "admin"
+email: "admin@test.com"
+password: "admin"
 ```
 
-For more details, refer to the `Dockerfile`.
-
 ## Testing
 
-### Testing the Backend
+The backend Go program can be tested by running `make test` for unit testing. The test results will be outputted in the terminal. You can also execute `test-coverage` to check the code test coverage.
 
-To test the backend Go program, you can use the following commands:
-
-- **Unit Testing**:
-  Run `make test` to execute unit tests. The results will be outputted in the terminal.
-
-- **Test Coverage**:
-  Run `make test-coverage` to check the code test coverage.
-
-- **HTML Coverage Report**:
-  Run `make test-coverage-html` to generate and browse the test coverage report in HTML format.
-
-- **Run Specific Tests**:
-  To run specific tests, use the command with an environment variable:
-  ```sh
-  TEST_PATHS="./server/..." make test
-  ```
-
-### Testing the Frontend
-
-Frontend testing includes unit tests and end-to-end (E2E) tests.
-
-- **Unit Testing**:
-  The unit tests for the frontend are conducted using Vitest. Run `pnpm test` to start the unit testing.
-
-- **End-to-End Testing**:
-  E2E testing is conducted using Playwright. To start the E2E testing, run:
-  ```sh
-  make test-frontend-e2e
-  ```
-
-### Continuous Integration for Testing
+Frontend testing is conducted using Playwright for end-to-end (E2E) testing. To start the E2E testing, run `make test-frontend-e2e`.
 
 Both frontend and backend testing are automated and will be performed during Git pull requests and as part of the build process using CircleCI or GitHub Actions.
 
-## Configurations
+## Project Structure
 
-The template configuration files are located in the `/conf` directory, with templates annotated in multiple languages named in the format `artalk.example.[lang].yml` (e.g., `artalk.example.zh-CN.yml`). Artalk will parse these template configuration files to generate the settings interface, environment variable names, and documentation. To improve performance, some data will be cached during the program's runtime to eliminate parsing time.
+Artalk is a monorepo project, which means all the source code is in the same repository. However, the frontend and backend are separated. The frontend part is located in `./ui` directory.
 
-In the `internal/config/config.go` file, there is a definition of the `Config` struct, which is used to parse the yml files into Go structs. This struct contains more precise type definitions. If you need to add, modify, or delete a configuration item, you must make changes to both the configuration file templates in `/conf` and the `Config` struct.
+- `bin/` - The compiled binary files. This directory is ignored by git.
+- `cmd/` - The source code for the command line tools.
+- `conf/` - The sample configuration files.
+- `docs/` - The documentation site source code.
+- `i18n/` - The translation files.
+- `internal/` - The internal packages.
+- `data/` - The local data. This directory is ignored by git.
+- `public/` - The static files. Built frontend files will be copied here.
+- `scripts/` - The scripts for development.
+- `server/` - The source code for the server.
+- `ui/` - The source code for the frontend.
 
-When you modify the configuration files, please run the following command to update the configuration data cache:
+## Translation
+
+Artalk aims to be a multilingual project. If you would like to contribute to the translation, here are some tips:
+
+If you just write some new features or do some fixes/refactoring, use the following command to generate the translation template
 
 ```sh
-make update-conf
+go run ./internal/i18n/gen -w . -d .
 ```
 
-To update the environment variable documentation, you can run the command:
-
-```sh
-make update-conf-docs
-```
-
-## Documentations
-
-The documentation consists of three parts, each associated with a specific package: **Guide documentation**, **Landing page**, and **Swagger API documentation**. Below is an organized summary of the relevant commands and their outputs for each package.
-
-### Guide Documentation (`docs`)
-
-- **Directory**: `docs/docs/guide`
-- **Dev Command**: `pnpm -F docs dev:docs`
-- **Build Command**: `pnpm -F docs build:docs`
-- **Output Directory**: `docs/docs/.vitepress/dist`
-
-### Landing Page (`docs-landing`)
-
-- **Directory**: `docs/landing`
-- **Dev Command**: `pnpm -F docs-landing dev:landing`
-- **Build Command**: `pnpm -F docs-landing build:landing`
-- **Output Directory**: `docs/landing/dist`
-
-### Swagger API Documentation (`docs-swagger`)
-
-- **Directory**: `docs/swagger`
-- **Build Command**: `make update-swagger`
-- **Output Directory**: `docs/swagger`
-
-Swagger definitions are located in the backend code at `/server`. After modifying the Swagger definitions, running the build command will update the Swagger docs and generate HTTP client code at `/ui/artalk/src/api/v2.ts`.
-
-### Combined Build
-
-- **Command to Build All Packages**: `pnpm build:docs`
-- **Combined Output Directory**: `docs/docs/.vitepress/dist`
-
-This command builds and combines all three packages into a single directory, ready for publishing.
-
-### Environment Variable Documentation
-
-- **File**: `docs/docs/guide/env.md`
-- **Command to Update**: `make update-conf-docs`
-
-This command reads the configuration template file located in `/conf` to update the environment variable documentation. Run this command after modifying the configuration template file.
-
-## Translation (i18n)
-
-If you write new features or make fixes/refactoring, use the following command to incrementally generate the translation files by parsing the source code for `i18n.T` function calls:
-
-```sh
-make update-i18n
-```
-
-If you're not a programmer and would like to help improve the translation, you can edit the translation files directly in the `/i18n` directory and then submit a pull request.
-
-## The End
-
-Thank you for your patience in reading this and for your interest and support in Artalk. We understand that the success of an open-source project relies on the contributions of every developer. Whether through code, documentation, testing, or feedback, your participation is the driving force behind the project's continuous progress. We sincerely invite you to join us in improving and enhancing Artalk.
-
-By collaborating, we can create a more robust and versatile platform that benefits the entire community. Your unique insights and expertise are invaluable, and together, we can achieve remarkable advancements. Whether you are a seasoned developer or just starting, there is always a place for your contributions in our project.
-
-If you have any questions or need assistance, please feel free to ask in the issue section on our GitHub page: https://github.com/ArtalkJS/Artalk/issues. Thank you once again for your support, and we look forward to working with you.
+If you're not a programmer and would like to help us improve the translation, you can edit the translation files directly in the `.i18n' directory and then submit a pull request.

Dockerfile

@@ -1,11 +1,12 @@
 ### build Artalk
-FROM golang:1.22.6-alpine3.20 AS builder
+FROM golang:1.21.3-alpine3.18 as builder
 
 WORKDIR /source
 
 # install tools
 RUN set -ex \
-    && apk add --no-cache make git gcc musl-dev bash
+    && apk add --no-cache make git gcc musl-dev nodejs bash npm\
+    && npm install -g pnpm@8.12.1
 
 # download go deps
 # (cache by separating the downloading of deps)
@@ -15,38 +16,20 @@ RUN go mod download
 # copy source code
 COPY . .
 
-## build UI
-ARG SKIP_UI_BUILD=false
-
-# install ui build toolchain
+# build
 RUN set -ex \
-    && if [ "$SKIP_UI_BUILD" = "false" ]; then \
-        apk add --no-cache nodejs npm \
-        && npm install -g pnpm@9.9.0 \
-    ;fi
-
-RUN set -ex \
-    && if [ "$SKIP_UI_BUILD" = "false" ]; then \
-        make build-frontend \
-    ;fi
-
-## build App
-ARG APP_VERSION=""
-ARG APP_COMMIT_HASH=""
-
-RUN set -ex \
-    && if [[ ! -z "$APP_VERSION" ]]; then export VERSION=$APP_VERSION ;fi \
-    && if [[ ! -z "$APP_COMMIT_HASH" ]]; then export COMMIT_HASH=$APP_COMMIT_HASH ;fi \
+    && export VERSION=$(git describe --tags --abbrev=0) \
+    && export COMMIT_SHA=$(git rev-parse --short HEAD) \
     && make build
 
 ### build final image
-FROM alpine:3.20
+FROM alpine:3.18
 
 # we set the timezone `Asia/Shanghai` by default, you can be modified
 # by `docker build --build-arg="TZ=Other_Timezone ..."`
 ARG TZ="Asia/Shanghai"
 
-ENV TZ=${TZ}
+ENV TZ ${TZ}
 
 COPY --from=builder /source/bin/artalk /artalk
 

Makefile

@@ -1,7 +1,8 @@
 PKG_NAME    := github.com/ArtalkJS/Artalk
 BIN_NAME	:= ./bin/artalk
-VERSION     ?= $(shell git describe --tags --abbrev=0 --match 'v*')
-COMMIT_HASH ?= $(shell git rev-parse --short HEAD)
+VERSION     ?= $(shell git describe --tags --abbrev=0)
+COMMIT_HASH := $(shell git rev-parse --short HEAD)
+DEV_VERSION := dev-$(COMMIT_HASH)
 
 HAS_RICHGO  := $(shell which richgo)
 GOTEST      ?= $(if $(HAS_RICHGO), richgo test, go test)
@@ -12,10 +13,7 @@ all: install build
 install:
 	go mod tidy
 
-run: all
-	$(BIN_NAME) $(ARGS)
-
-build:
+build: build-frontend
 	go build \
     	-ldflags "-s -w -X $(PKG_NAME)/internal/config.Version=$(VERSION) \
         -X $(PKG_NAME)/internal/config.CommitHash=$(COMMIT_HASH)" \
@@ -25,6 +23,9 @@ build:
 build-frontend:
 	./scripts/build-frontend.sh
 
+run: all
+	$(BIN_NAME) $(ARGS)
+
 build-debug:
 	@echo "Building Artalk $(VERSION) for debugging..."
 	@go build \
@@ -35,36 +36,24 @@ build-debug:
 		$(PKG_NAME)
 
 dev: build-debug
-	ATK_SITE_DEFAULT="ArtalkDocs" \
-	ATK_TRUSTED_DOMAINS="http://localhost:5173 http://localhost:23367" \
 	$(BIN_NAME) $(ARGS)
 
 test:
-	$(GOTEST) -timeout 20m $(or $(TEST_PATHS), ./...)
+	$(GOTEST) -timeout 20m ./internal/...
 
 test-coverage:
-	$(GOTEST) -cover $(or $(TEST_PATHS), ./...)
+	$(GOTEST) -cover ./...
 
 test-coverage-html:
-	$(GOTEST) -v -coverprofile=coverage.out $(or $(TEST_PATHS), ./...)
+	$(GOTEST) -v -coverprofile=coverage.out ./...
 	go tool cover -html=coverage.out
 
-test-frontend-e2e:
-	./scripts/frontend-e2e-test.sh $(if $(REPORT), --show-report)
-
 update-i18n:
 	go generate ./internal/i18n
 
-update-conf:
-	go generate ./internal/config
-
-update-conf-docs:
-	go run ./internal/config/meta/gen --format markdown --locale zh-CN -o ./docs/docs/guide/env.md
-
 update-swagger:
 	go install github.com/swaggo/swag/cmd/swag@latest
-	swag init -g server/server.go --output ./docs/swagger --requiredByDefault
-	pnpm -r swagger:build-http-client
+	swag init -g server/server.go --output ./docs/swagger
 
 docker-build:
 	./scripts/docker-build.sh
@@ -72,7 +61,9 @@ docker-build:
 docker-push:
 	./scripts/docker-build.sh --push
 
-.PHONY: all install run build build-frontend build-debug dev \
-	test test-coverage test-coverage-html test-frontend-e2e \
-	update-i18n update-conf update-conf-docs update-swagger \
-	docker-build docker-push;
+test-frontend-e2e:
+	./scripts/frontend-e2e-test.sh $(if $(REPORT), --show-report)
+
+.PHONY: all install build build-frontend build-debug \
+	dev test test-coverage test-coverage-html update-i18n \
+	docker-build docker-push test-frontend-e2e;

README.en.md

@@ -1,120 +1,129 @@
 <p align="center">
-<img src="https://user-images.githubusercontent.com/22412567/171680920-6e74b77c-c565-487b-bff1-4f94976ecbe7.png" alt="Artalk" width="100%">
+<img src="https://user-images.githubusercontent.com/22412567/137740516-d9e97af0-fb3b-4dab-b331-671a9a2a3a63.png" alt="Artalk" width="100%">
 </p>
 
 # Artalk
 
-[![npm version](https://img.shields.io/npm/v/artalk.svg?style=flat-square)](https://www.npmjs.com/package/artalk)
-[![npm downloads](https://img.shields.io/npm/dt/artalk.svg?style=flat-square)](https://www.npmjs.com/package/artalk)
-[![Docker Pulls](https://img.shields.io/docker/pulls/artalk/artalk-go?style=flat-square)](https://hub.docker.com/r/artalk/artalk-go)
-[![Go Report Card](https://goreportcard.com/badge/github.com/ArtalkJS/Artalk?style=flat-square)](https://goreportcard.com/report/github.com/ArtalkJS/Artalk)
-[![CircleCI](https://img.shields.io/circleci/build/gh/ArtalkJS/Artalk?style=flat-square)](https://circleci.com/gh/ArtalkJS/Artalk/tree/master)
-[![Codecov](https://img.shields.io/codecov/c/gh/ArtalkJS/Artalk?style=flat-square)](https://codecov.io/gh/ArtalkJS/Artalk)
-[![npm bundle size](https://img.shields.io/bundlephobia/minzip/artalk?style=flat-square)](https://bundlephobia.com/package/artalk)
+[![npm 版本](https://img.shields.io/npm/v/artalk.svg?style=flat-square)](https://www.npmjs.com/package/artalk)
+[![npm 下载量](https://img.shields.io/npm/dt/artalk.svg?style=flat-square)](https://www.npmjs.com/package/artalk)
+[![尺寸](https://badgen.net/bundlephobia/minzip/artalk?style=flat-square)](https://bundlephobia.com/package/artalk)
+[![CircleCI](https://circleci.com/gh/ArtalkJS/Artalk/tree/master.svg?style=svg)](https://circleci.com/gh/ArtalkJS/Artalk/tree/master)
 
-[中文](./README.md) • [Official Website](https://artalk.js.org) • [Latest Release](https://github.com/ArtalkJS/Artalk/releases) • [Changelog](https://github.com/ArtalkJS/Artalk/blob/master/CHANGELOG.md)
+> 🌌 A self-hosted comment system
 
-🌌 Artalk is a simple yet feature-rich commenting system that you can deploy out of the box and integrate into any blog, website, or web application.
+[简体中文](./README.md) / [Documentation](https://artalk.js.org) / [Releases](https://github.com/ArtalkJS/Artalk/releases) / [Artalk](https://github.com/ArtalkJS/Artalk)
 
-- 🍃 Frontend ~40KB, pure Vanilla JS
-- 🍱 Backend Golang, efficient lightweight cross-platform
-- 🐳 One-click deployment via Docker, convenient and fast
-- 🌈 Open-source program, self-hosted, privacy-first
+---
+
+- 🍃 Lightweight (~30kB)
+- 👨‍👧‍👦 Secure (Self-hosted)
+- 🐳 Easy to use (Very Easy)
+- 🍱 Golang backend (Fast and Cross Platform)
+- 🌊 TypeScript × Vanilla × Vite (No Dependencies)
 
 ## Features
 
-<!-- prettier-ignore-start -->
+- Sidebar: Multi-site centralized management
+- Notification Center: Red badge alert / Mark as read
+- Verification: User Verification Badge / Password access
+- Moderation: Anti-spam detection / Captcha frequency limit
+- Emoticons: Insert emoji / Quickly import presets
+- Email Notify: Template customization / Send to multi-admin
+- Site Isolation: Multi-site management / Admin assignment
+- Page Management: Provide page title / Easy to look up
+- Image Upload: Upload to localhost / various remote image host
+- Private Space Mode: Only visible to yourself / Message board
+- Multiple Msg Pushers: Support Telegram / Slack / LINE
+- Nested Comments: Switchable to Flat Mode
+- Comment Vote: For or against comments
+- Comment Sort: Sort by popularity or time
+- Comment PIN: Pin important comments
+- Track only author: Show only author's comments
+- Asynchronous: Send comments without waiting
+- Infinite Scrolling: Provide various comment content pagination custom
+- AutoSave: A anti-lost editor
+- AutoFill: Autofill user profile
+- Preview: Real-time preview of markdown
+- Dark Mode: Prevents eye disease damage
+- Collapse Comment: I do not want you to see this comment
+- Data Backup: Prevent comment data loss
+- Data Migration: Switch back and forth between different commenting systems
+- Multiple comments on one page: Multiple comment areas on one page (seems useless
+- Markdown: Markdown syntax was supported by default
+- LaTex support: Import KaTex plugin to integrate LaTex parser for artalk
+- Using [Vite](https://github.com/vitejs/vite): The ultimate developer experience
 
-<!-- features -->
-* [Sidebar](https://artalk.js.org/guide/frontend/sidebar.html): Quick management, intuitive browsing
-* [Social Login](https://artalk.js.org/guide/frontend/auth.html): Quick login via social accounts
-* [Email Notification](https://artalk.js.org/guide/backend/email.html): Multiple sending methods, email templates
-* [Multi-channel Push](https://artalk.js.org/guide/backend/admin_notify.html): Multiple push methods, notification templates
-* [In-site Notifications](https://artalk.js.org/guide/frontend/sidebar.html): Red dot marking, mention list
-* [CAPTCHA](https://artalk.js.org/guide/backend/captcha.html): Multiple verification types, frequency limitation
-* [Comment Moderation](https://artalk.js.org/guide/backend/moderator.html): Content detection, spam interception
-* [Image Upload](https://artalk.js.org/guide/backend/img-upload.html): Custom upload, support for image hosting
-* [Markdown](https://artalk.js.org/guide/intro.html): Support Markdown syntax
-* [Emoticons](https://artalk.js.org/guide/frontend/emoticons.html): Compatible with OwO, quick integration
-* [Multi-site](https://artalk.js.org/guide/backend/multi-site.html): Site isolation, centralized management
-* [Admin](https://artalk.js.org/guide/backend/multi-site.html): Password verification, badge identification
-* [Page Management](https://artalk.js.org/guide/frontend/sidebar.html): Quick view, one-click title jump
-* [Page Views Statistics](https://artalk.js.org/guide/frontend/pv.html): Easily track page views
-* [Hierarchy](https://artalk.js.org/guide/frontend/config.html#nestmax): Nested paginated lists, scroll loading
-* [Comment Voting](https://artalk.js.org/guide/frontend/config.html#vote): Upvote or downvote comments
-* [Comment Sorting](https://artalk.js.org/guide/frontend/config.html#listsort): Multiple sorting options, freedom to choose
-* [Comment Search](https://artalk.js.org/guide/frontend/sidebar.html): Quickly search comment content
-* [Comment Pinning](https://artalk.js.org/guide/frontend/sidebar.html): Pin important messages
-* [Author-only View](https://artalk.js.org/guide/frontend/config.html): Show only comments from the author
-* [Comment Jumping](https://artalk.js.org/guide/intro.html): Quickly jump to referenced comments
-* [Auto Save](https://artalk.js.org/guide/frontend/config.html): Content input auto-saving
-* [IP Geolocation](https://artalk.js.org/guide/frontend/ip-region.html): User IP location display
-* [Data Migration](https://artalk.js.org/guide/transfer.html): Free migration, quick backup
-* [Image Lightbox](https://artalk.js.org/guide/frontend/lightbox.html): Quickly integrate image lightbox
-* [Image Lazy Loading](https://artalk.js.org/guide/frontend/img-lazy-load.html): Delay loading images, optimize experience
-* [Latex](https://artalk.js.org/guide/frontend/latex.html): Latex formula parsing integration
-* [Dark Mode](https://artalk.js.org/guide/frontend/config.html#darkmode): Dark mode switching
-* [Extension Plugins](https://artalk.js.org/develop/): Create more possibilities
-* [Multi-language](https://artalk.js.org/guide/frontend/i18n.html): Multi-language switching
-* [Command Line](https://artalk.js.org/guide/backend/config.html): Command line operation management capability
-* [API Documentation](https://artalk.js.org/develop/): Provides OpenAPI format documentation
-* [Program Upgrade](https://artalk.js.org/guide/backend/update.html): Version detection, one-click upgrade
-<!-- /features -->
+## Getting Started
 
-<!-- prettier-ignore-end -->
+Reference to：[**Documentation**](https://artalk.js.org/guide/deploy.html)
 
-## Installation
-
-Deploy via Docker with one click:
-
-```bash
-docker run -d \
-    --name artalk \
-    -p 8080:23366 \
-    -v $(pwd)/data:/data \
-    -e "TZ=America/New_York" \
-    -e "ATK_LOCALE=en" \
-    -e "ATK_SITE_DEFAULT=Artalk Blog" \
-    -e "ATK_SITE_URL=https://example.com" \
-    artalk/artalk-go
+```sh
+$ pnpm add artalk
 ```
 
-Integrate Artalk into your webpage:
-
-<!-- prettier-ignore-start -->
-
 ```ts
+import Artalk from 'artalk'
+
 Artalk.init({
-  el:      '#Comments',
-  site:    'Artalk Blog',
-  server:  'https://artalk.example.com',
-  pageKey: '/2018/10/02/hello-world.html'
+  el:        '#Comments',
+  pageKey:   'http://your_domain/post/1', // Page Link
+  pageTitle: 'The title of your page',    // Page Title
+  server:    'http://localhost:8080/api', // Server URL
+  site:      'Site Name',
+  locale:    'en'
 })
 ```
 
-<!-- prettier-ignore-end -->
+### Docker
 
-[**Learn More →**](https://artalk.js.org/guide/deploy.html)
+```sh
+docker run -d \
+  --name artalk \
+  -p 8080:23366 \
+  -v $(pwd)/data:/data \
+  artalk/artalk-go
+```
 
-## For Developers
+### Docker Compose
 
-Pull requests are welcome!
+```sh
+mkdir Artalk
+cd Artalk
 
-See [Development](https://artalk.js.org/develop/) and [Contributing](./CONTRIBUTING.md) for information on working with the codebase, getting a local development setup, and contributing changes.
+vim docker-compose.yaml
+```
+
+```yaml
+version: "3.5"
+services:
+  artalk:
+    container_name: artalk
+    image: artalk/artalk-go
+    ports:
+      - 8080:23366
+    volumes:
+      - ./data:/data
+```
+
+```sh
+docker-compose up -d
+```
+
+## Development
+
+see [CONTRIBUTING.md](./CONTRIBUTING.md)
 
 ## Contributors
 
-Your contributions enrich the open-source community, fostering learning, inspiration, and innovation. We deeply value your involvement. Thank you for being a vital part of our community! 🥰
-
 [![](https://contrib.rocks/image?repo=ArtalkJS/Artalk)](https://github.com/ArtalkJS/Artalk/graphs/contributors)
 
 ## Supporters
 
 [![Stargazers repo roster for @ArtalkJS/Artalk](https://reporoster.com/stars/ArtalkJS/Artalk)](https://github.com/ArtalkJS/Artalk/stargazers)
 
-## Repobeats Analytics
+## Feedback
 
-![Alt](https://repobeats.axiom.co/api/embed/a9fc9191ac561bc5a8ee2cddc81e635ecaebafb6.svg 'Repobeats analytics image')
+Thanks for the help and feedback provided by the community, if you have good suggestions or comments, please go to [issues](https://github.com/ArtalkJS/Artalk/issues) to let us know at any time.
 
 ## Stargazers over time
 

README.md

@@ -12,100 +12,109 @@
 [![Codecov](https://img.shields.io/codecov/c/gh/ArtalkJS/Artalk?style=flat-square)](https://codecov.io/gh/ArtalkJS/Artalk)
 [![npm bundle size](https://img.shields.io/bundlephobia/minzip/artalk?style=flat-square)](https://bundlephobia.com/package/artalk)
 
-[English](./README.en.md) • [官方网站](https://artalk.js.org) • [最新版本](https://github.com/ArtalkJS/Artalk/releases) • [更新日志](https://github.com/ArtalkJS/Artalk/blob/master/CHANGELOG.md)
+> 🌌 Golang 自托管评论系统
 
-Artalk 是一款简单易用但功能丰富的评论系统，你可以开箱即用地部署并置入任何博客、网站、Web 应用。
+[English](./README.en.md) / [官方文档](https://artalk.js.org) / [最新版本](https://github.com/ArtalkJS/Artalk/releases)
 
-- 🍃 前端 ~40KB，纯天然 Vanilla JS
-- 🍱 后端 Golang，高效轻量跨平台
-- 🐳 通过 Docker 一键部署，方便快捷
-- 🌈 开源程序，自托管，隐私至上
+---
+
+- 🍃 轻量 (~30kB)
+- 👨‍👧‍👦 安全 (自托管)
+- 🐳 易上手 (防脱发)
+- 🍱 Golang 后端 (快速 / 跨平台)
+- 🌊 Vanilla × TypeScript × Vite (纯天然 / 无依赖)
 
 ## 特性
 
-<!-- prettier-ignore-start -->
+- 侧 边 栏 ：支持多站点集中化管理
+- 通知中心：红点的标记 / 提及列表
+- 身份验证：徽标自定义 / 密码验证
+- 评论审核：反垃圾检测 / 频率限制
+- 表情符号：插入表情包 / 快速导入
+- 邮件提醒：模版自定义 / 多管理员
+- 站点隔离：管理员分配 / 多个站点
+- 页面管理：标题可显示 / 快速跳转
+- 图片上传：上传到本地 / 多种图床
+- 多元推送：支持 钉钉 飞书 TG
+- 无限层级：可切换为平铺模式
+- 评论投票：赞同还是反对评论
+- 评论排序：按热度或时间排序
+- 评论置顶：重要消息置顶显示
+- 只看作者：仅显示作者的评论
+- 说说模式：仅自己可发布评论
+- 异步处理：发送评论无需等待
+- 滚动加载：评论内容分页处置
+- 自动保存：用户输入防丢功能
+- 自动填充：用户链接自动填充
+- 实时预览：评论内容实时预览
+- 夜间模式：防止眼部疾病伤害
+- 评论折叠：这个不打算给你康
+- 数据备份：防止评论数据丢失
+- 数据迁移：快速切换评论系统
+- Markdown：默认支持 MD 语法
+- 支持 Latex：提供集成 Katex 插件
+- 使用 [Vite](https://github.com/vitejs/vite)：属于开发者的极致体验
 
-<!-- features -->
-* [侧边栏](https://artalk.js.org/guide/frontend/sidebar.html): 快速管理、直观浏览
-* [社交登录](https://artalk.js.org/guide/frontend/auth.html): 通过社交账号快速登录
-* [邮件通知](https://artalk.js.org/guide/backend/email.html): 多种发送方式、邮件模板
-* [多元推送](https://artalk.js.org/guide/backend/admin_notify.html): 多种推送方式、通知模版
-* [站内通知](https://artalk.js.org/guide/frontend/sidebar.html): 红点标记、提及列表
-* [验证码](https://artalk.js.org/guide/backend/captcha.html): 多种验证类型、频率限制
-* [评论审核](https://artalk.js.org/guide/backend/moderator.html): 内容检测、垃圾拦截
-* [图片上传](https://artalk.js.org/guide/backend/img-upload.html): 自定义上传、支持图床
-* [Markdown](https://artalk.js.org/guide/intro.html): 支持 Markdown 语法
-* [表情包](https://artalk.js.org/guide/frontend/emoticons.html): 兼容 OwO，快速集成
-* [多站点](https://artalk.js.org/guide/backend/multi-site.html): 站点隔离、集中管理
-* [管理员](https://artalk.js.org/guide/backend/multi-site.html): 密码验证、徽章标识
-* [页面管理](https://artalk.js.org/guide/frontend/sidebar.html): 快速查看、标题一键跳转
-* [浏览量统计](https://artalk.js.org/guide/frontend/pv.html): 轻松统计网页浏览量
-* [层级结构](https://artalk.js.org/guide/frontend/config.html#nestmax): 嵌套分页列表、滚动加载
-* [评论投票](https://artalk.js.org/guide/frontend/config.html#vote): 赞同或反对评论
-* [评论排序](https://artalk.js.org/guide/frontend/config.html#listsort): 多种排序方式，自由选择
-* [评论搜索](https://artalk.js.org/guide/frontend/sidebar.html): 快速搜索评论内容
-* [评论置顶](https://artalk.js.org/guide/frontend/sidebar.html): 重要消息置顶显示
-* [仅看作者](https://artalk.js.org/guide/frontend/config.html): 仅显示作者的评论
-* [评论跳转](https://artalk.js.org/guide/intro.html): 快速跳转到引用的评论
-* [自动保存](https://artalk.js.org/guide/frontend/config.html): 输入内容防丢功能
-* [IP 属地](https://artalk.js.org/guide/frontend/ip-region.html): 用户 IP 属地展示
-* [数据迁移](https://artalk.js.org/guide/transfer.html): 自由迁移、快速备份
-* [图片灯箱](https://artalk.js.org/guide/frontend/lightbox.html): 图片灯箱快速集成
-* [图片懒加载](https://artalk.js.org/guide/frontend/img-lazy-load.html): 延迟加载图片，优化体验
-* [Latex](https://artalk.js.org/guide/frontend/latex.html): Latex 公式解析集成
-* [夜间模式](https://artalk.js.org/guide/frontend/config.html#darkmode): 夜间模式切换
-* [扩展插件](https://artalk.js.org/develop/): 创造更多可能性
-* [多语言](https://artalk.js.org/guide/frontend/i18n.html): 多国语言切换
-* [命令行](https://artalk.js.org/guide/backend/config.html): 命令行操作管理能力
-* [API 文档](https://artalk.js.org/develop/): 提供 OpenAPI 格式文档
-* [程序升级](https://artalk.js.org/guide/backend/update.html): 版本检测，一键升级
-<!-- /features -->
-
-<!-- prettier-ignore-end -->
+更多内容请查看：[**介绍文档**](https://artalk.js.org/guide/intro.html)
 
 ## 安装
 
-通过 Docker 一键部署：
+参考：[**部署文档**](https://artalk.js.org/guide/deploy.html)
 
 ```bash
-docker run -d \
-    --name artalk \
-    -p 8080:23366 \
-    -v $(pwd)/data:/data \
-    -e "TZ=Asia/Shanghai" \
-    -e "ATK_LOCALE=zh-CN" \
-    -e "ATK_SITE_DEFAULT=Artalk 的博客" \
-    -e "ATK_SITE_URL=https://example.com" \
-    artalk/artalk-go
+npm install artalk
 ```
 
-在网页中引入 Artalk:
-
-<!-- prettier-ignore-start -->
-
 ```ts
+import Artalk from 'artalk'
+
 Artalk.init({
-  el:      '#Comments',
-  site:    'Artalk 的博客',
-  server:  'https://artalk.example.com',
-  pageKey: '/2018/10/02/hello-world.html'
+  el:     '#Comments',
+  site:   'Artalk 的博客',
+  server: 'https://artalk.example.com'
 })
 ```
 
-<!-- prettier-ignore-end -->
+### Docker
 
-[**了解更多 →**](https://artalk.js.org/guide/deploy.html)
+```bash
+docker run -d \
+  --name artalk \
+  -p 8080:23366 \
+  -v $(pwd)/data:/data \
+  --restart=always \
+  artalk/artalk-go
+```
 
-## For Developers
+### Docker Compose
 
-Pull requests are welcome!
+```bash
+vim docker-compose.yaml
+```
 
-See [Development](https://artalk.js.org/develop/) and [Contributing](./CONTRIBUTING.md) for information on working with the codebase, getting a local development setup, and contributing changes.
+```yaml
+version: "3.5"
+services:
+  artalk:
+    container_name: artalk
+    image: artalk/artalk-go
+    restart: always
+    ports:
+      - 8080:23366
+    volumes:
+      - ./data:/data
+```
+
+```bash
+docker-compose up -d
+```
+
+## Development
+
+see [CONTRIBUTING.md](./CONTRIBUTING.md)
 
 ## Contributors
 
-Your contributions enrich the open-source community, fostering learning, inspiration, and innovation. We deeply value your involvement. Thank you for being a vital part of our community! 🥰
-
 [![](https://contrib.rocks/image?repo=ArtalkJS/Artalk)](https://github.com/ArtalkJS/Artalk/graphs/contributors)
 
 ## Supporters
@@ -114,7 +123,105 @@ Your contributions enrich the open-source community, fostering learning, inspira
 
 ## Repobeats Analytics
 
-![Alt](https://repobeats.axiom.co/api/embed/a9fc9191ac561bc5a8ee2cddc81e635ecaebafb6.svg 'Repobeats analytics image')
+![Alt](https://repobeats.axiom.co/api/embed/a9fc9191ac561bc5a8ee2cddc81e635ecaebafb6.svg "Repobeats analytics image")
+
+## 特别致谢
+
+感谢社区提供的帮助与反馈，若有好的建议与意见欢迎前往 [ISSUES](https://github.com/ArtalkJS/Artalk/issues) 随时告知。
+
+## TODOs
+
+- [x] Golang 后端
+- [x] 多数据库支持
+  - [x] SQLite
+  - [x] MySQL
+  - [x] Postgres
+  - [x] SQLServer
+- [x] 多缓存数据库支持
+  - [x] In-memory (内建缓存)
+  - [x] Redis
+  - [x] Memcache
+- [x] 多站点支持
+- [x] 评论获取分页
+- [x] 评论点赞投票
+- [x] 浏览量统计
+- [x] 评论分页加载
+- [x] 评论置顶 / 精华
+- [x] 评论排序 (热度 / 时间)
+- [x] 通知中心
+  - [x] 提及
+  - [x] 全部
+  - [x] 我的
+  - [x] 待审
+- [x] 管理员控制台
+  - [x] 评论
+  - [x] 页面
+  - [x] 站点
+  - [x] 用户
+  - [x] 设置 (GUI)
+- [x] 数据导入 ([Artransfer](https://artalk.js.org/guide/transfer.html))
+  - [x] Artrans
+  - [x] WordPress
+  - [x] Typecho ([插件](https://github.com/ArtalkJS/Artrans-Typecho) / [Artransfer-CLI](https://github.com/ArtalkJS/Artransfer-CLI))
+  - [x] Valine
+  - [x] Disqus
+  - [x] Commento
+  - [x] Waline ([Artransfer-CLI](https://github.com/ArtalkJS/Artransfer-CLI))
+  - [x] Twikoo
+  - [x] Artalk v1 (PHP)
+- [x] 数据导出
+- [x] 邮件多种发送方式
+  - [x] SMTP
+  - [x] 阿里云邮件
+  - [x] 系统调用 sendmail
+- [x] 邮件多模板自定义
+- [x] 邮件异步队列发送
+  - [ ] 队列持久化
+- [x] 用户已读标记
+- [x] 验证码
+  - [x] 图片验证码
+  - [x] [Turnstile](https://www.cloudflare.com/products/turnstile/)
+  - [x] [ReCAPTCHA](https://www.google.com/recaptcha/about/)
+  - [x] [hCaptcha](https://www.hcaptcha.com/)
+  - [x] [极验](https://www.geetest.com/)滑动验证码
+- [x] 反垃圾
+  - [x] [Akismet](https://akismet.com/)
+  - [x] [阿里云内容安全](https://help.aliyun.com/document_detail/28417.html)
+  - [x] [腾讯云内容安全](https://cloud.tencent.com/document/product/1124/64508)
+  - [x] 关键字过滤
+- [x] 评论通知管理员 ([notify](https://github.com/nikoksr/notify))
+  - [x] Telegram Bot
+  - [x] 飞书 WebHook Bot
+  - [x] 钉钉
+  - [x] Bark
+  - [x] Slack
+  - [x] LINE
+  - [x] 自定义 HTTP 回调
+- [ ] 命令行管理
+- [ ] 博客邮件订阅
+- [x] 用户鉴权机制
+- [x] 跨域非法请求阻止
+- [x] 全局验证码操作次数限制
+- [x] JWT 登陆状态验证
+- [x] 时区自定义
+- [x] 只看作者功能
+- [x] 图片上传
+- [x] 图片上传到图床 ([upgit](https://github.com/pluveto/upgit))
+- [ ] 图片管理
+- [ ] 附件上传 / 管理
+- [ ] 表情包统一管理
+  - [ ] 导入表情包
+  - [ ] 表情包图片地址控制
+- [ ] AT 提及 (@)
+- [ ] 评论话题 (#)
+- [ ] 评论标签分类系统
+- [ ] 主题样式更换
+- [ ] 规范化 API
+- [ ] 扩展中心
+- [ ] 开放用户注册
+- [ ] 第三方登录接入
+- [x] 多语言 / 国际化 (i18n)
+- [x] 一键升级
 
 ## Stargazers over time
 

SECURITY.md

@@ -1,3 +0,0 @@
-# Reporting Security Issues
-
-The features of Artalk are continuously being improved, and we are also striving to enhance security. However, potential issues may still exist. If you discover any security vulnerabilities in Artalk, please promptly contact us via [GitHub Issues](https://github.com/ArtalkJS/Artalk/issues) or email at artalkjs@gmail.com. We will make every effort to address the issue as quickly as possible. Thank you for your support!

cmd/admin.go

@@ -25,23 +25,14 @@ func NewAdminCommand(app *ArtalkCmd) *cobra.Command {
 			fmt.Println(" " + i18n.T("Create admin account"))
 			fmt.Println("--------------------------------")
 
-			// get from flags
-			username, _ := cmd.Flags().GetString("name")
-			email, _ := cmd.Flags().GetString("email")
-			password, _ := cmd.Flags().GetString("password")
-
-			if username == "" || email == "" || password == "" {
-				var err error
-				username, email, password, err = credentials()
-				if err != nil {
-					log.Fatal(err)
-				}
+			username, email, password, err := credentials()
+			if err != nil {
+				log.Fatal(err)
 			}
 
 			findUser := app.Dao().FindUser(username, email)
 			if !findUser.IsEmpty() {
 				findUser.SetPasswordEncrypt(password)
-				findUser.IsAdmin = true
 				if err := app.Dao().UpdateUser(&findUser); err != nil {
 					log.Fatal(err)
 				}
@@ -71,10 +62,6 @@ func NewAdminCommand(app *ArtalkCmd) *cobra.Command {
 		},
 	}
 
-	flag(adminCmd, "name", "", i18n.T("Username"))
-	flag(adminCmd, "email", "", i18n.T("Email"))
-	flag(adminCmd, "password", "", i18n.T("Password"))
-
 	return adminCmd
 }
 

cmd/import.go

@@ -1,7 +1,6 @@
 package cmd
 
 import (
-	"encoding/json"
 	"errors"
 	"os"
 
@@ -17,44 +16,26 @@ func NewImportCommand(app *ArtalkCmd) *cobra.Command {
 		Aliases: []string{},
 		Short:   "Artransfer import",
 		Long:    "\n# Artransfer - Import\n\n  See the documentation to learn more: https://artalk.js.org/guide/transfer.html",
+		Args:    cobra.MinimumNArgs(1),
 		Run: func(cmd *cobra.Command, args []string) {
-			// Prepare params
-			params := &artransfer.ImportParams{}
-
-			// Parse JSON parameters from flags
-			if jsonParams, _ := cmd.Flags().GetString("parameters"); jsonParams != "" {
-				if err := json.Unmarshal([]byte(jsonParams), params); err != nil {
-					log.Fatal("Failed to parse JSON parameters: ", err)
-				}
+			parcelFile := args[0]
+			if _, err := os.Stat(parcelFile); errors.Is(err, os.ErrNotExist) {
+				log.Fatal(i18n.T("{{name}} not found", map[string]interface{}{"name": i18n.T("File")}))
 			}
 
-			// If JSON file or JSON data is not provided in flags, try to get it from arguments
-			if params.JsonFile == "" && params.JsonData == "" {
-				if len(args) == 0 {
-					log.Fatal(i18n.T("{{name}} is required", map[string]interface{}{"name": "FILENAME"}))
-				}
-				params.JsonFile = args[0]
-			}
+			payload := args[1:]
+			payload = append(payload, "json_file:"+parcelFile)
 
-			// Parse flags to params
-			if flagAssumeyes, err := cmd.Flags().GetBool("assumeyes"); err == nil {
-				params.Assumeyes = flagAssumeyes
-			}
-
-			// Check if file exists if JsonFile is provided
-			if params.JsonFile != "" {
-				if _, err := os.Stat(params.JsonFile); errors.Is(err, os.ErrNotExist) {
-					log.Fatal(i18n.T("{{name}} not found", map[string]interface{}{"name": i18n.T("File")}))
-				}
-			}
-
-			// Run import
+			// import Artrans
+			params := artransfer.ArrToImportParams(payload)
+			params.Assumeyes, _ = cmd.Flags().GetBool("assumeyes")
 			artransfer.RunImportArtrans(app.Dao(), params)
+
+			log.Info(i18n.T("Import complete"))
 		},
 	}
 
 	flagPV(importCmd, "assumeyes", "y", false, "Automatically answer yes for all questions.")
-	flagPV(importCmd, "parameters", "p", "", "JSON format parameters for the import command.")
 
 	return importCmd
 }

cmd/upgrade.go

@@ -32,7 +32,7 @@ func NewUpgradeCommand() *cobra.Command {
 			if !ignoreVersionCheck {
 				v := semver.MustParse(strings.TrimPrefix(config.Version, "v"))
 				if !found || latest.Version.LTE(v) {
-					log.Info(i18n.T("Current version is the latest") + " (v" + v.String() + ")")
+					log.Println(i18n.T("Current version is the latest") + " (v" + v.String() + ")")
 					return
 				}
 			}
@@ -49,7 +49,7 @@ func NewUpgradeCommand() *cobra.Command {
 				log.Fatal(i18n.T("Update failed")+" ", err)
 			}
 
-			log.Info(i18n.T("Update complete"))
+			log.Println(i18n.T("Update complete"))
 			fmt.Printf("\n"+
 				"-------------------------------\n"+
 				"    v%s  Release Note\n"+

codecov.yml

@@ -1,2 +0,0 @@
-ignore:
-  - "docs/*"

conf/artalk.example.simple.yml

@@ -2,37 +2,32 @@ host: "0.0.0.0"
 port: 23366
 app_key: ""
 debug: false
-locale: en
-timezone: Asia/Shanghai
-site_default: Default Site
-site_url: ""
+locale: "en"
+timezone: "Asia/Shanghai"
+site_default: "Default Site"
 login_timeout: 259200
 db:
-  type: sqlite
-  file: ./data/artalk.db
+  type: "sqlite"
+  file: "./data/artalk.db"
   table_prefix: ""
-  name: artalk
-  host: localhost
+  name: "artalk"
+  host: "localhost"
   port: 3306
-  user: root
+  user: "root"
   password: ""
-  charset: utf8mb4
+  charset: "utf8mb4"
   ssl: false
-  prepare_stmt: true
-http:
-  body_limit: 100
-  proxy_header: ""
 log:
   enabled: true
-  filename: ./data/artalk.log
+  filename: "./data/artalk.log"
 cache:
   enabled: false
-  type: builtin
+  type: "builtin"
   expires: 30
   warm_up: false
   server: ""
   redis:
-    network: tcp
+    network: "tcp"
     username: ""
     password: ""
     db: 0
@@ -49,23 +44,23 @@ moderator:
     enabled: false
     secret_id: ""
     secret_key: ""
-    region: ap-guangzhou
+    region: "ap-guangzhou"
   aliyun:
     enabled: false
     access_key_id: ""
     access_key_secret: ""
-    region: cn-shanghai
+    region: "cn-shanghai"
   keywords:
     enabled: false
     pending: false
     files:
-      - ./data/keywords_1.txt
+      - "./data/keywords_1.txt"
     file_sep: "\n"
-    replace_to: x
+    replac_to: "x"
 captcha:
   enabled: true
   always: false
-  captcha_type: image
+  captcha_type: "image"
   action_limit: 3
   action_reset: 60
   turnstile:
@@ -82,32 +77,31 @@ captcha:
     captcha_key: ""
 img_upload:
   enabled: true
-  path: ./data/artalk-img/
+  path: "./data/artalk-img/"
   max_size: 5
   public_path: null
   upgit:
     enabled: false
-    exec: upgit -c UPGIT_CONF_FILE_PATH -t /artalk-img
+    exec: "./upgit -c UPGIT_CONF_FILE_PATH -t /artalk-img"
     del_local: true
 email:
   enabled: false
-  send_type: smtp
+  send_type: "smtp"
   send_name: "{{reply_nick}}"
-  send_addr: noreply@example.com
+  send_addr: "noreply@example.com"
   mail_subject: "[{{site_name}}] You got a reply from @{{reply_nick}}"
-  mail_tpl: default
+  mail_tpl: "default"
   smtp:
-    host: smtp.qq.com
+    host: "smtp.qq.com"
     port: 587
-    username: example@qq.com
+    username: "example@qq.com"
     password: ""
   ali_dm:
     access_key_id: ""
     access_key_secret: ""
-    account_name: noreply@example.com
+    account_name: "noreply@example.com"
 admin_notify:
-  notify_tpl: default
-  notify_pending: false
+  notify_tpl: "default"
   noise_mode: false
   email:
     enabled: true
@@ -120,11 +114,10 @@ admin_notify:
       - 7777777
   bark:
     enabled: false
-    server: http://day.app/xxxxxxx/
+    server: "http://day.app/xxxxxxx/"
   lark:
     enabled: false
     webhook_url: ""
-    msg_type: "text"
   webhook:
     enabled: false
     url: ""
@@ -144,100 +137,25 @@ admin_notify:
     receivers:
       - "USER_ID_1"
       - "GROUP_ID_1"
-auth:
-  enabled: false
-  anonymous: false
-  callback: "http://localhost:23366/api/v2/auth/{provider}/callback"
-  email:
-    enabled: true
-    verify_subject: "Your Code - {{code}}"
-    verify_tpl: default
-  github:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  gitlab:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  gitea:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  google:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  mastodon:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  twitter:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  facebook:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  discord:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  steam:
-    enabled: false
-    api_key: ""
-  apple:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  microsoft:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  wechat:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  tiktok:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  slack:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  line:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  patreon:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  auth0:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-    domain: ""
 frontend:
   placeholder: ""
   noComment: ""
   sendBtn: ""
   editorTravel: true
-  emoticons: https://cdn.jsdelivr.net/gh/ArtalkJS/Emoticons/grps/default.json
+  emoticons: "https://cdn.jsdelivr.net/gh/ArtalkJS/Emoticons/grps/default.json"
   vote: true
   voteDown: false
   uaBadge: false
   listSort: true
+  pvEl: "#ArtalkPV"
+  countEl: "#ArtalkCount"
   preview: true
-  flatMode: auto
-  darkMode: inherit
+  flatMode: "auto"
   nestMax: 2
   nestSort: DATE_ASC
   gravatar:
-    mirror: https://www.gravatar.com/avatar/
-    params: sha256=1&d=mp&s=240
+    mirror: "https://www.gravatar.com/avatar/"
+    params: "d=mp&s=240"
   pagination:
     pageSize: 20
     readMore: true
@@ -246,7 +164,5 @@ frontend:
     content: 300
     children: 400
     scrollable: false
-  imgLazyLoad: false
   reqTimeout: 15000
   versionCheck: true
-  pluginURLs: []

conf/artalk.example.yml

@@ -10,19 +10,16 @@ app_key: ""
 # Debug mode
 debug: false
 
-# Language (follow Unicode BCP 47) ["en", "zh-CN", "zh-TW", "ja", "fr", "ko", "ru"]
+# Language (follow Unicode BCP 47) ["en", "zh-CN", "zh-TW", "jp"]
 # -- see https://www.techonthenet.com/js/language_tags.php --
-locale: en
+locale: "en"
 
 # Timezone (follow IANA Time Zone Database)
 # -- see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones --
-timezone: Asia/Shanghai
+timezone: "Asia/Shanghai"
 
 # Default site name (create when app is first launched)
-site_default: Default Site
-
-# Default site url
-site_url: ""
+site_default: "Default Site"
 
 # Login timeout (in seconds)
 login_timeout: 259200
@@ -30,49 +27,40 @@ login_timeout: 259200
 # Database
 db:
   # Database type ["sqlite", "mysql", "pgsql", "mssql"]
-  type: sqlite
+  type: "sqlite"
   # Database file (only for SQLite)
-  file: ./data/artalk.db
+  file: "./data/artalk.db"
   # Table prefix (e.g. "atk_")
   table_prefix: ""
   # -- The following is not necessary for SQLite --
   # Database name
-  name: artalk
+  name: "artalk"
   # Host address
-  host: localhost
+  host: "localhost"
   # Host port
   port: 3306
   # Database user
-  user: root
+  user: "root"
   # Database password
   password: ""
   # Database charset
-  charset: utf8mb4
+  charset: "utf8mb4"
   # Enable SSL mode
   ssl: false
-  # Prepared Statement
-  prepare_stmt: true
-
-# Web server
-http:
-  # Body size limit (unit: MB)
-  body_limit: 100
-  # Proxy Header (fill `X-Forwarded-For` to get user real IP if behind a trusted reverse proxy or CDN)
-  proxy_header: ""
 
 # Logging
 log:
   # Enable logging
   enabled: true
   # Log file path
-  filename: ./data/artalk.log
+  filename: "./data/artalk.log"
 
 # Cache
 cache:
   # Enable cache
   enabled: false
   # Cache type ["redis", "memcache", "builtin"]
-  type: builtin
+  type: "builtin"
   # Cache expiration time (in minutes)
   expires: 30
   # Cache warm up (warm up cache when program starts)
@@ -83,7 +71,7 @@ cache:
   # Redis config
   redis:
     # Connection type ["tcp", "unix"]
-    network: tcp
+    network: "tcp"
     # Redis username
     username: ""
     # Redis password
@@ -123,7 +111,7 @@ moderator:
     enabled: false
     secret_id: ""
     secret_key: ""
-    region: ap-guangzhou
+    region: "ap-guangzhou"
   # Aliyun Content Security
   # (Auto review comments with Aliyun Content Security)
   # -- see https://help.aliyun.com/document_detail/28417.html --
@@ -131,7 +119,7 @@ moderator:
     enabled: false
     access_key_id: ""
     access_key_secret: ""
-    region: cn-shanghai
+    region: "cn-shanghai"
   # Keyword filter (local offline dictionary)
   keywords:
     # Enable keyword filter
@@ -140,9 +128,9 @@ moderator:
     pending: false
     # Dictionary file (support multiple dictionary files)
     files:
-      - ./data/keywords_1.txt
+      - "./data/keywords_1.txt"
     file_sep: "\n"
-    replace_to: x
+    replac_to: "x"
 
 # Captcha
 captcha:
@@ -151,7 +139,7 @@ captcha:
   # Captcha is required always
   always: false
   # Captcha type ["image", "turnstile", "recaptcha", "hcaptcha", "geetest"]
-  captcha_type: image
+  captcha_type: "image"
   # Action limit
   # (the number of actions required to activate captcha)
   action_limit: 3
@@ -181,7 +169,7 @@ img_upload:
   # Enable image upload
   enabled: true
   # Image storage
-  path: ./data/artalk-img/
+  path: "./data/artalk-img/"
   # Image size limit (unit: MB)
   max_size: 5
   # Image link base path (default: "/static/images/")
@@ -191,7 +179,7 @@ img_upload:
     # Enable Upgit
     enabled: false
     # Command line arguments
-    exec: upgit -c UPGIT_CONF_FILE_PATH -t /artalk-img
+    exec: "./upgit -c UPGIT_CONF_FILE_PATH -t /artalk-img"
     # Delete local image after upload success
     del_local: true
 
@@ -200,23 +188,23 @@ email:
   # Enable email notification
   enabled: false
   # Send method ["smtp", "ali_dm", "sendmail"]
-  send_type: smtp
+  send_type: "smtp"
   # Nick name of sender
   send_name: "{{reply_nick}}"
   # Email address of sender
-  send_addr: noreply@example.com
+  send_addr: "noreply@example.com"
   # Email subject
   mail_subject: "[{{site_name}}] You got a reply from @{{reply_nick}}"
   # Email template file (set to file path to use custom template)
-  mail_tpl: default
+  mail_tpl: "default"
   # SMTP send (set send method to "smtp" to enable)
   smtp:
     # Email address of sender
-    host: smtp.qq.com
+    host: "smtp.qq.com"
     # Email port
     port: 587
     # Email address of sender
-    username: example@qq.com
+    username: "example@qq.com"
     # Password
     password: ""
   # Aliyun mail push
@@ -224,14 +212,12 @@ email:
   ali_dm:
     access_key_id: ""
     access_key_secret: ""
-    account_name: noreply@example.com
+    account_name: "noreply@example.com"
 
-# Multi-Push
+# Multi-push
 admin_notify:
   # Notification template (set to file path to use custom template)
-  notify_tpl: default
-  # Pending comment still send notification (notifications are still sent when comments are intercepted)
-  notify_pending: false
+  notify_tpl: "default"
   # Noise mode
   # -- noise_mode is disabled by default. --
   # -- When this option is set to `false`, only messages sent to the administrator will be notified, --
@@ -254,18 +240,14 @@ admin_notify:
   # Bark
   bark:
     enabled: false
-    server: http://day.app/xxxxxxx/
-  # Lark
+    server: "http://day.app/xxxxxxx/"
   lark:
     enabled: false
     webhook_url: ""
-    # Message type ["text", "card"]
-    msg_type: "text"
   # WebHook
   webhook:
     enabled: false
     url: ""
-  # DingTalk
   ding_talk:
     enabled: false
     token: ""
@@ -282,110 +264,8 @@ admin_notify:
     channel_secret: ""
     channel_access_token: ""
     receivers:
-      - USER_ID_1
-      - GROUP_ID_1
-
-# Social Login
-auth:
-  # Enable Social Login
-  enabled: false
-  # Allow anonymous commenting (Allow skipping verification, only fill in an anonymous nickname and email)
-  anonymous: false
-  # Callback URL (https://example.com/api/v2/auth/{provider}/callback)
-  callback: "http://localhost:23366/api/v2/auth/{provider}/callback"
-  # Email
-  email:
-    # Enable email password login
-    enabled: true
-    # Verification email subject
-    verify_subject: "Your Code - {{code}}"
-    # Verification email template (set to file path to use custom template)
-    verify_tpl: default
-  # GitHub
-  github:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  # GitLab
-  gitlab:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  # Gitea
-  gitea:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  # Google
-  google:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  # Mastodon
-  mastodon:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  # Twitter
-  twitter:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  # Facebook
-  facebook:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  # Discord
-  discord:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  # Steam
-  steam:
-    enabled: false
-    api_key: ""
-  # Apple
-  apple:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  # Microsoft
-  microsoft:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  # WeChat
-  wechat:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  # Tiktok
-  tiktok:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  # Slack
-  slack:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  # Line
-  line:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  # Patreon
-  patreon:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  # Auth0
-  auth0:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-    domain: ""
+      - "USER_ID_1"
+      - "GROUP_ID_1"
 
 # UI Settings
 frontend:
@@ -398,7 +278,7 @@ frontend:
   # Movable comment box
   editorTravel: true
   # Emoticons
-  emoticons: https://cdn.jsdelivr.net/gh/ArtalkJS/Emoticons/grps/default.json
+  emoticons: "https://cdn.jsdelivr.net/gh/ArtalkJS/Emoticons/grps/default.json"
   # Vote button
   vote: true
   # Dislike button
@@ -407,12 +287,14 @@ frontend:
   uaBadge: false
   # Comment sorting
   listSort: true
+  # Page PV binding element
+  pvEl: "#ArtalkPV"
+  # Comment count binding element
+  countEl: "#ArtalkCount"
   # Editor real-time preview
   preview: true
   # Flatten mode ["auto", true, false]
-  flatMode: auto
-  # Dark mode ["inherit", "auto"]
-  darkMode: inherit
+  flatMode: "auto"
   # Maximum nesting level
   nestMax: 2
   # Nesting comment sorting rules ["DATE_ASC", "DATE_DESC", "VOTE_UP_DESC"]
@@ -420,9 +302,9 @@ frontend:
   # Gravatar
   gravatar:
     # API URL
-    mirror: https://www.gravatar.com/avatar/
+    mirror: "https://www.gravatar.com/avatar/"
     # API parameters
-    params: sha256=1&d=mp&s=240
+    params: "d=mp&s=240"
   # Comment pagination
   pagination:
     # Number of comments per page
@@ -439,11 +321,7 @@ frontend:
     children: 400
     # Scrollable (scrollable height limit area)
     scrollable: false
-  # Image lazy load [false, "native", "data-src"]
-  imgLazyLoad: false
   # Request timeout (unit: ms)
   reqTimeout: 15000
   # Version check
   versionCheck: true
-  # Plugins
-  pluginURLs: []

conf/artalk.example.zh-CN.yml

@@ -10,66 +10,54 @@ app_key: ""
 # 调试模式
 debug: false
 
-# 语言 ["en", "zh-CN", "zh-TW", "ja", "fr", "ko", "ru"]
-locale: zh-CN
+# 语言 ["en", "zh-CN", "zh-TW", "jp"]
+locale: "zh-CN"
 
 # 时间区域
-timezone: Asia/Shanghai
+timezone: "Asia/Shanghai"
 
 # 默认站点名
-site_default: 默认站点
+site_default: "默认站点"
 
-# 默认站点地址
-site_url: ""
-
-# 登录有效时长 (单位：秒)
+# 登陆有效时长 (单位：秒)
 login_timeout: 259200
 
 # 数据库
 db:
   # 数据库类型 ["sqlite", "mysql", "pgsql", "mssql"]
-  type: sqlite
+  type: "sqlite"
   # 数据库文件 (仅 SQLite 数据库需填写)
-  file: ./data/artalk.db
+  file: "./data/artalk.db"
   # 数据库名称
-  name: artalk
+  name: "artalk"
   # 数据库地址
-  host: localhost
+  host: "localhost"
   # 数据库端口
   port: 3306
   # 数据库账户
-  user: root
+  user: "root"
   # 数据库密码
   password: ""
   # 编码格式
-  charset: utf8mb4
+  charset: "utf8mb4"
   # 表前缀 (例如："atk_")
   table_prefix: ""
   # 启用 SSL
   ssl: false
-  # 预编译语句
-  prepare_stmt: true
-
-# 服务器
-http:
-  # 请求体大小限制 (单位：MB)
-  body_limit: 100
-  # 代理标头名 (当使用 CDN 时填写 `X-Forwarded-For` 获取用户真实 IP)
-  proxy_header: ""
 
 # 日志
 log:
   # 启用日志
   enabled: true
   # 日志文件路径
-  filename: ./data/artalk.log
+  filename: "./data/artalk.log"
 
 # 缓存
 cache:
   # 启用缓存
   enabled: false
   # 缓存类型 ["redis", "memcache", "builtin"]
-  type: builtin
+  type: "builtin"
   # 缓存过期时间 (单位：分钟)
   expires: 30
   # 缓存启动预热 (程序启动时预热缓存)
@@ -79,7 +67,7 @@ cache:
   # Redis 配置
   redis:
     # 连接方式 ["tcp", "unix"]
-    network: tcp
+    network: "tcp"
     # 用户名
     username: ""
     # 密码
@@ -88,8 +76,7 @@ cache:
     db: 0
 
 # 可信域名
-# -- 例如：["https://artalk.example.com:23366"] --
-trusted_domains: []
+trusted_domains: [] # 例如：["https://artalk.example.com:23366"]
 
 # SSL
 ssl:
@@ -101,14 +88,12 @@ ssl:
   key_path: ""
 
 # 管理员账户
-# --
-# - name: "admin"
-#   email: "admin@example.com"
-#   password: "" # 支持 bcrypt 或 md5 加密，如："(bcrypt)$2y$10$ti4vZYIrxVN8rLcYXVgXCO.GJND0dyI49r7IoF3xqIx8bBRmIBZRm"
-#   badge_name: "管理员"
-#   badge_color: "#0083FF"
-# --
-admin_users: []
+admin_users:
+  # - name: "admin"
+  #   email: "admin@example.com"
+  #   password: "" # 支持 bcrypt 或 md5 加密，如："(md5)50c21190c6e4e5418c6a90d2b5031119"
+  #   badge_name: "管理员"
+  #   badge_color: "#0083FF"
 
 # 评论审核
 moderator:
@@ -125,14 +110,14 @@ moderator:
     enabled: false
     secret_id: ""
     secret_key: ""
-    region: ap-guangzhou
+    region: "ap-guangzhou"
   # 阿里云内容安全
   # (https://help.aliyun.com/document_detail/28417.html)
   aliyun:
     enabled: false
     access_key_id: ""
     access_key_secret: ""
-    region: cn-shanghai
+    region: "cn-shanghai"
   # 关键词过滤 (本地离线词库)
   keywords:
     enabled: false
@@ -140,11 +125,11 @@ moderator:
     pending: false
     # 词库文件 (支持多个词库文件)
     files:
-      - ./data/词库_1.txt
+      - "./data/词库_1.txt"
     # 词库文件内容分割符 (例如填写 "\n" 文件中一行一个关键词)
     file_sep: "\n"
     # 替换字符
-    replace_to: x
+    replac_to: "x"
 
 # 验证码
 captcha:
@@ -153,7 +138,7 @@ captcha:
   # 总是需要验证码
   always: false
   # 验证类型 ["image", "turnstile", "recaptcha", "hcaptcha", "geetest"]
-  captcha_type: image
+  captcha_type: "image"
   # 激活验证码所需操作次数
   action_limit: 3
   # 重置操作计数器超时 (单位：s, 设为 -1 不重置)
@@ -177,21 +162,21 @@ captcha:
     captcha_id: ""
     captcha_key: ""
 
-# IP 属地
+# IP 归属地
 ip_region:
-  # 启用 IP 属地展示
+  # 启用 IP 归属地展示
   enabled: false
   # 数据文件路径 (.xdb 格式)
-  db_path: ./data/ip2region.xdb
+  db_path: "./data/ip2region.xdb"
   # 显示精度 ["province", "city", "country"]
-  precision: province
+  precision: "province"
 
 # 图片上传
 img_upload:
   # 启用图片上传
   enabled: true
   # 图片存放路径
-  path: ./data/artalk-img/
+  path: "./data/artalk-img/"
   # 图片大小限制 (单位：MB)
   max_size: 5
   # 图片链接基础路径 (默认为 "/static/images/")
@@ -202,7 +187,7 @@ img_upload:
     # 启用 Upgit
     enabled: false
     # 命令行参数
-    exec: upgit -c <upgit配置文件路径> -t /artalk-img
+    exec: "./upgit -c <upgit配置文件路径> -t /artalk-img"
     # 上传后删除本地的图片
     del_local: true
 
@@ -211,23 +196,23 @@ email:
   # 启用邮件通知
   enabled: false
   # 发送方式 ["smtp", "ali_dm", "sendmail"]
-  send_type: smtp
+  send_type: "smtp"
   # 发信人昵称
   send_name: "{{reply_nick}}"
   # 发信人地址
-  send_addr: noreply@example.com
+  send_addr: "noreply@example.com"
   # 邮件标题
   mail_subject: "[{{site_name}}] 您收到了来自 @{{reply_nick}} 的回复"
   # 邮件模板文件 (填入文件路径使用自定义模板)
-  mail_tpl: default
+  mail_tpl: "default"
   # SMTP 发送 (启用请将发送方式设为 "smtp")
   smtp:
     # 发件地址
-    host: smtp.qq.com
+    host: "smtp.qq.com"
     # 发件端口
     port: 587
     # 用户名
-    username: example@qq.com
+    username: "example@qq.com"
     # 密码
     password: ""
   # 阿里云邮件推送
@@ -235,14 +220,12 @@ email:
   ali_dm:
     access_key_id: ""
     access_key_secret: ""
-    account_name: noreply@example.com
+    account_name: "noreply@example.com"
 
 # 多元推送
 admin_notify:
   # 通知模版 (填入文件路径使用自定义模板)
-  notify_tpl: default
-  # 待审评论仍然发送通知 (当评论被拦截时仍然发送通知)
-  notify_pending: false
+  notify_tpl: "default"
   # 嘈杂模式
   noise_mode: false
   # 邮件通知管理员
@@ -262,13 +245,11 @@ admin_notify:
   # Bark
   bark:
     enabled: false
-    server: http://day.app/xxxxxxx/
+    server: "http://day.app/xxxxxxx/"
   # 飞书
   lark:
     enabled: false
     webhook_url: ""
-    # 消息类型 ["text", "card"]
-    msg_type: "text"
   # WebHook
   webhook:
     enabled: false
@@ -283,119 +264,17 @@ admin_notify:
     enabled: false
     oauth_token: ""
     receivers:
-      - CHANNEL_ID
+      - "CHANNEL_ID"
   # LINE
   line:
     enabled: false
     channel_secret: ""
     channel_access_token: ""
     receivers:
-      - USER_ID_1
-      - GROUP_ID_1
+      - "USER_ID_1"
+      - "GROUP_ID_1"
 
-# 社交登录
-auth:
-  # 启用社交登录
-  enabled: false
-  # 允许匿名评论 (允许跳过验证，仅填写匿名的昵称和邮箱)
-  anonymous: false
-  # 回调地址 (https://example.com/api/v2/auth/{provider}/callback)
-  callback: "http://localhost:23366/api/v2/auth/{provider}/callback"
-  # Email
-  email:
-    # 启用邮箱密码登录
-    enabled: true
-    # 邮箱验证邮件标题
-    verify_subject: "您的验证码是 - {{code}}"
-    # 邮箱验证邮件模板 (填入文件路径使用自定义模板)
-    verify_tpl: default
-  # GitHub
-  github:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  # GitLab
-  gitlab:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  # Gitea
-  gitea:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  # Google
-  google:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  # Mastodon
-  mastodon:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  # Twitter
-  twitter:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  # Facebook
-  facebook:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  # Discord
-  discord:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  # Steam
-  steam:
-    enabled: false
-    api_key: ""
-  # Apple
-  apple:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  # Microsoft
-  microsoft:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  # 微信
-  wechat:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  # Tiktok
-  tiktok:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  # Slack
-  slack:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  # Line
-  line:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  # Patreon
-  patreon:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-  # Auth0
-  auth0:
-    enabled: false
-    client_id: ""
-    client_secret: ""
-    domain: ""
-
-# 界面配置
+# 前端配置
 frontend:
   # 评论框占位文字
   placeholder: ""
@@ -406,7 +285,7 @@ frontend:
   # 评论框穿梭
   editorTravel: true
   # 表情包
-  emoticons: https://cdn.jsdelivr.net/gh/ArtalkJS/Emoticons/grps/default.json
+  emoticons: "https://cdn.jsdelivr.net/gh/ArtalkJS/Emoticons/grps/default.json"
   # 投票按钮
   vote: true
   # 反对按钮
@@ -415,12 +294,14 @@ frontend:
   uaBadge: false
   # 评论排序功能
   listSort: true
+  # 页面 PV 绑定元素
+  pvEl: "#ArtalkPV"
+  # 评论数绑定元素
+  countEl: "#ArtalkCount"
   # 编辑器实时预览功能
   preview: true
   # 平铺模式 ["auto", true, false]
-  flatMode: auto
-  # 夜间模式 ["inherit", "auto"]
-  darkMode: inherit
+  flatMode: "auto"
   # 最大嵌套层数
   nestMax: 2
   # 嵌套评论排序规则 ["DATE_ASC", "DATE_DESC", "VOTE_UP_DESC"]
@@ -428,9 +309,9 @@ frontend:
   # 头像 Gravatar
   gravatar:
     # API 地址
-    mirror: https://weavatar.com/avatar/
+    mirror: "https://cravatar.cn/avatar/"
     # API 参数
-    params: sha256=1&d=mp&s=240
+    params: "d=mp&s=240"
   # 评论分页
   pagination:
     # 每页评论数
@@ -447,11 +328,7 @@ frontend:
     children: 400
     # 滚动限高 (允许限高区域滚动)
     scrollable: false
-  # 图片懒加载 [false, "native", "data-src"]
-  imgLazyLoad: false
   # 请求超时 (单位：毫秒)
   reqTimeout: 15000
   # 版本检测
   versionCheck: true
-  # 插件
-  pluginURLs: []

docker-compose.yml

@@ -1,9 +1,8 @@
-version: "3.8"
+version: "3.5"
 services:
   artalk:
     container_name: artalk
     image: artalk/artalk-go
-    restart: unless-stopped
     build:
       context: ./
       dockerfile: Dockerfile
@@ -11,8 +10,3 @@ services:
       - 8080:23366
     volumes:
       - ./data:/data
-    environment:
-      - TZ=Asia/Shanghai
-      - ATK_LOCALE=zh-CN
-      - ATK_SITE_DEFAULT=Artalk 的博客
-      - ATK_SITE_URL=https://example.com

docker-entrypoint.sh

@@ -14,11 +14,11 @@ if [ "$1" != 'gen' ] && ( [ ! -e /data/artalk.yml ] && [ ! -e /data/artalk-go.ym
         upMsg+=$'# please unmount the config file volume from your container\n'
         upMsg+=$'# and edit "/data/artalk.yml" for configuration.'
         echo "$upMsg" > /conf.yml
-        echo "$(date) [info][docker] Copy config file from '/conf.yml' to '/data/artalk.yml' for upgrade"
+        echo "$(date) [info] Copy config file from '/conf.yml' to '/data/artalk.yml' for upgrade"
     else
         # Generate new config
         artalk gen conf /data/artalk.yml
-        echo "$(date) [info][docker] Generate new config file to '/data/artalk.yml'"
+        echo "$(date) [info] Generate new config file to '/data/artalk.yml'"
     fi
 fi
 

docs/.gitignore

@@ -0,0 +1,3 @@
+/.vitepress/dist/
+/.vitepress/cache/
+/public/http-api.html

docs/.npmrc

@@ -0,0 +1,2 @@
+shamefully-hoist=true
+auto-install-peers=true

docs/.vitepress/config.ts

@@ -9,14 +9,18 @@ export default defineConfig({
 
   head: [
     ['link', { rel: 'icon', href: '/favicon.png' }],
-    [
-      'meta',
-      {
-        name: 'viewport',
-        content:
-          'width=device-width, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0, user-scalable=no, target-densitydpi=device-dpi',
-      },
-    ],
+    ['meta', { name: 'viewport', content: 'width=device-width, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0, user-scalable=no, target-densitydpi=device-dpi' }],
+    // artalk
+    // ['link', { href: `https://npm.elemecdn.com/artalk@${Version.latest}/dist/Artalk.css`, rel: 'stylesheet' }],
+    ['link', { href: `https://artalk.qwqaq.com/dist/Artalk.css`, rel: 'stylesheet' }],
+    // ['script', { src: ArtalkCDN.JS }],
+    // light gallery
+    ['link', { href: 'https://npm.elemecdn.com/lightgallery@2.3.0/css/lightgallery.css', rel: 'stylesheet' }],
+    ['script', { src: 'https://npm.elemecdn.com/lightgallery@2.3.0/lightgallery.min.js' }],
+    // katex
+    // ['link', { href: "https://npm.elemecdn.com/katex@0.15.3/dist/katex.min.css", rel: 'stylesheet' }],
+    // ['script', { src: 'https://npm.elemecdn.com/katex@0.15.3/dist/katex.min.js' }],
+    // ['script', { src: 'https://npm.elemecdn.com/@artalkjs/plugin-katex/dist/artalk-plugin-katex.js' }],
   ],
 
   lastUpdated: true,
@@ -29,94 +33,90 @@ export default defineConfig({
     },
     config: (md) => {
       md.use(iterator, 'artalk_version', 'text', function (tokens, idx) {
-        tokens[idx].content = tokens[idx].content.replace(
-          /:ArtalkVersion:/g,
-          Version.latest,
-        )
-      })
+        tokens[idx].content = tokens[idx].content.replace(/:ArtalkVersion:/g, Version.latest)
+      });
       md.use(iterator, 'artalk_version_link', 'link_open', (tokens, idx) => {
-        const href = tokens[idx].attrGet('href')
-        tokens[idx].attrSet(
-          'href',
-          href.replace(/:ArtalkVersion:/g, Version.latest),
-        )
-      })
+          const href = tokens[idx].attrGet('href')
+          tokens[idx].attrSet('href', href.replace(/:ArtalkVersion:/g, Version.latest))
+      });
     },
   },
 
   locales: {
     root: {
       label: '简体中文',
-      lang: 'zh',
-      link: 'https://artalk.js.org/',
+      lang: 'zh'
     },
     en: {
       label: 'English',
       lang: 'en',
-      link: 'https://artalk-js-org.translate.goog/guide/intro?_x_tr_sl=auto&_x_tr_tl=en-US&_x_tr_hl=en-US&_x_tr_pto=wapp',
-    },
+      link: 'https://artalk-js-org.translate.goog/guide/intro?_x_tr_sl=auto&_x_tr_tl=en-US&_x_tr_hl=en-US&_x_tr_pto=wapp'
+      // link: '/en/'
+    }
   },
 
   themeConfig: {
     sidebar: {
-      '/guide/': [
+      "/guide/": [
         {
-          text: '快速开始',
+          text: "快速开始",
           collapsed: false,
           items: [
             { text: '项目介绍', link: '/guide/intro.md' },
             { text: '程序部署', link: '/guide/deploy.md' },
             { text: '数据迁移', link: '/guide/transfer.md' },
-          ],
+          ]
         },
         {
-          text: '核心指南',
+          text: "核心指南",
           collapsed: false,
           items: [
             { text: '侧边栏', link: '/guide/frontend/sidebar.md' },
             { text: '邮件通知', link: '/guide/backend/email.md' },
             { text: '多元推送', link: '/guide/backend/admin_notify.md' },
-            { text: '社交登录', link: '/guide/frontend/auth.md' },
             { text: '评论审核', link: '/guide/backend/moderator.md' },
             { text: '验证码', link: '/guide/backend/captcha.md' },
             { text: '图片上传', link: '/guide/backend/img-upload.md' },
             { text: '账户与多站点', link: '/guide/backend/multi-site.md' },
             { text: '解析相对路径', link: '/guide/backend/relative-path.md' },
-          ],
+            { text: '如何配置界面', link: '/guide/backend/fe-control.md' },
+            { text: 'English (i18n)', link: '/guide/frontend/i18n.md' },
+          ]
         },
         {
-          text: '进阶指南',
+          text: "进阶指南",
           collapsed: false,
           items: [
             { text: '表情包', link: '/guide/frontend/emoticons.md' },
             { text: '浏览量统计', link: '/guide/frontend/pv.md' },
-            { text: 'LaTeX', link: '/guide/frontend/latex.md' },
+            { text: 'Latex', link: '/guide/frontend/latex.md' },
             { text: '图片灯箱', link: '/guide/frontend/lightbox.md' },
-            { text: '图片懒加载', link: '/guide/frontend/img-lazy-load.md' },
-            { text: 'IP 属地', link: '/guide/frontend/ip-region.md' },
-            { text: '多语言', link: '/guide/frontend/i18n.md' },
-            { text: '开发文档', link: '/develop/index.md' },
+            { text: 'IP 归属地', link: '/guide/frontend/ip-region.md' },
+            { text: '精简版本', link: '/guide/frontend/artalk-lite.md' },
+            { text: '置入博客', link: '/guide/frontend/import-blog.md' },
+            { text: '置入框架', link: '/guide/frontend/import-framework.md' },
+            { text: '前端 API', link: '/develop/fe-api.md', },
+            { text: '开发文档', link: '/develop/index.md', },
           ],
         },
         {
-          text: '配置文档',
-          collapsed: false,
+          text: "配置文档",
+          collapsed: true,
           items: [
-            { text: '环境变量', link: '/guide/env.md' },
-            { text: '配置文件', link: '/guide/backend/config.md' },
-            { text: '界面配置', link: '/guide/frontend/config.md' },
-          ],
+            { text: '后端配置', link: '/guide/backend/config.md' },
+            { text: '前端配置', link: '/guide/frontend/config.md' },
+          ]
         },
         {
-          text: '部署说明',
+          text: "部署说明",
           collapsed: true,
           items: [
             { text: '守护进程', link: '/guide/backend/daemon.md' },
             { text: '反向代理', link: '/guide/backend/reverse-proxy.md' },
-            { text: '编译构建', link: '/develop/contributing.md' },
+            { text: '编译构建', link: '/guide/backend/build.md' },
             { text: '程序升级', link: '/guide/backend/update.md' },
             { text: 'Docker', link: '/guide/backend/docker.md' },
-          ],
+          ]
         },
         {
           text: '更多内容',
@@ -126,28 +126,23 @@ export default defineConfig({
             { text: '扩展阅读', link: '/guide/extras.md' },
             { text: '案例展示', link: '/guide/cases.md' },
             { text: '关于我们', link: '/guide/about.md' },
-          ],
-        },
+          ]
+        }
       ],
-      '/develop/': [
+      "/develop/": [
         {
           text: '开发文档',
           items: [
-            { text: '开发说明', link: '/develop/index.md' },
-            { text: '贡献指南', link: '/develop/contributing.md' },
-            { text: '置入博客', link: '/develop/import-blog.md' },
-            { text: '置入框架', link: '/develop/import-framework.md' },
-            { text: '前端 API', link: '/develop/fe-api.md' },
-            { text: '前端 Event', link: '/develop/event.md' },
-            { text: '插件开发', link: '/develop/plugin.md' },
-            { text: '兼容性', link: '/develop/compatibility.md' },
-            {
-              text: 'HTTP API',
-              link: 'https://artalk.js.org/http-api.html',
-            },
-          ],
-        },
-      ],
+            { text: '开发说明', link: '/develop/index.md', },
+            { text: '前端 API', link: '/develop/fe-api.md', },
+            { text: '前端 Event', link: '/develop/event.md', },
+            { text: '插件开发', link: '/develop/plugs.md' },
+            { text: '🔬 HTTP API', link: 'https://artalk.js.org/http-api.html', },
+            { text: '📖 Contributing Guide', link: 'https://github.com/ArtalkJS/Artalk/blob/master/CONTRIBUTING.md' },
+            { text: '🔖 Code of Conduct', link: 'https://github.com/ArtalkJS/Artalk/blob/master/CODE_OF_CONDUCT.md' },
+          ]
+        }
+      ]
     },
 
     nav: [
@@ -184,16 +179,16 @@ export default defineConfig({
             text: '代码仓库',
             link: 'https://github.com/ArtalkJS/Artalk',
           },
-          // {
-          //   text: "文档镜像 (国内)",
-          //   link: "https://artalk-docs.qwqaq.com",
-          // },
+          {
+            text: '文档镜像 (国内)',
+            link: 'https://artalk-docs.qwqaq.com'
+          }
         ],
       },
     ],
 
     socialLinks: [
-      { icon: 'github', link: 'https://github.com/ArtalkJS/Artalk' },
+      { icon: 'github', link: 'https://github.com/ArtalkJS/Artalk' }
     ],
 
     search: {
@@ -203,20 +198,14 @@ export default defineConfig({
         apiKey: '6c6ebc345a87b738264f19095b78c91c',
         indexName: 'artalk-js',
         searchParameters: {
-          facetFilters: ['lang:zh-CN'],
-        },
-      },
+          facetFilters: ['lang:zh-CN']
+        }
+      }
     },
 
     editLink: {
-      pattern: 'https://github.com/ArtalkJS/Artalk/edit/master/docs/docs/:path',
-      text: '完善文档',
+      pattern: 'https://github.com/ArtalkJS/Artalk/edit/master/docs/:path',
+      text: '完善文档'
     },
-  },
-
-  vite: {
-    server: {
-      open: '/guide/intro.html',
-    },
-  },
+  }
 })

docs/.vitepress/theme/Artalk.vue

@@ -0,0 +1,95 @@
+<template>
+  <ClientOnly>
+    <div ref="el" style="margin-top: 20px;"></div>
+  </ClientOnly>
+</template>
+
+<script setup lang="ts">
+import { watch, nextTick, ref, onMounted, onUnmounted } from 'vue'
+import { useData, useRouter } from 'vitepress'
+import type Artalk from 'artalk'
+
+const el = ref<HTMLElement | null>(null)
+
+const router = useRouter()
+const page = useData().page
+
+let artalk: Artalk
+
+onMounted(() => {
+  initArtalk(getConfByPage())
+})
+
+watch(() => router.route.data.relativePath, () => {
+  nextTick(() => {
+    artalk.update(getConfByPage())
+    artalk.reload()
+  })
+})
+
+onUnmounted(() => {
+  artalk.destroy()
+})
+
+function initArtalk(conf: any) {
+  import('artalk').then(({ default: Artalk }) => {
+    artalk = Artalk.init({
+      el:        el.value,
+      emoticons: '/assets/emoticons/default.json',
+      gravatar:   {
+        mirror: 'https://cravatar.cn/avatar/'
+      },
+      ...conf
+    })
+  }).then(() => {
+    loadExtraFuncs()
+  })
+}
+
+function getConfByPage() {
+  return {
+    pageKey:   'https://artalk.js.org'+location.pathname,
+    pageTitle:  page.value.title,
+    server:    'https://artalk.qwqaq.com',
+    site:      'ArtalkDocs',
+  }
+}
+
+function loadExtraFuncs() {
+  // 图片灯箱插件
+  artalk.on('list-loaded', () => {
+    document.querySelectorAll('.atk-comment .atk-content').forEach(($content) => {
+      const imgEls = $content.querySelectorAll<HTMLImageElement>('img:not([atk-emoticon]):not([atk-lightbox])');
+      imgEls.forEach((imgEl) => {
+        imgEl.setAttribute('atk-lightbox', '')
+        const linkEl = document.createElement('a')
+        linkEl.setAttribute('class', 'atk-img-link')
+        linkEl.setAttribute('href', imgEl.src)
+        linkEl.setAttribute('data-src', imgEl.src)
+        linkEl.append(imgEl.cloneNode())
+        imgEl.replaceWith(linkEl)
+      })
+      // @ts-ignore
+      if (imgEls.length) lightGallery($content, { selector: '.atk-img-link' })
+    })
+  })
+
+  // 夜间模式
+  const darkMode = document.querySelector('html').classList.contains('dark')
+  artalk.setDarkMode(darkMode)
+
+  new MutationObserver((mList) => {
+    mList.forEach((m) => {
+      if (m.attributeName !== 'class') return
+
+      // @ts-ignore
+      const darkMode = m.target.classList.contains('dark')
+      artalk.setDarkMode(darkMode)
+    })
+  }).observe(document.querySelector('html'), { attributes: true })
+}
+</script>
+
+<style>
+
+</style>

docs/.vitepress/theme/Artransfer.vue

@@ -1,9 +1,5 @@
 <template>
-  <iframe
-    id="artransferIframe"
-    src="https://artransfer.netlify.app/?iframe=1"
-    style="width: 100%; height: 520px; border: 0"
-  ></iframe>
+  <iframe src="https://artransfer.netlify.app/?iframe=1" style="width: 100%;height: 520px;border: 0;" id="artransferIframe"></iframe>
 </template>
 
 <script lang="ts">
@@ -28,10 +24,15 @@ export default defineComponent({
       mList.forEach((m) => {
         if (m.attributeName !== 'class') return
 
-        const darkMode = (<HTMLElement>m.target).classList.contains('dark')
+        // @ts-ignore
+        const darkMode = m.target.classList.contains('dark')
         setArtransferIframeDarkMode(darkMode)
       })
     }).observe(document.querySelector('html'), { attributes: true })
-  },
+  }
 })
 </script>
+
+<style>
+
+</style>

docs/.vitepress/theme/Layout.vue

@@ -4,6 +4,9 @@ import { onMounted } from 'vue'
 import './style.scss'
 
 const { Layout } = DefaultTheme
+
+onMounted(() => {
+})
 </script>
 
 <template>

docs/.vitepress/theme/index.ts

@@ -1,8 +1,8 @@
 import DefaultTheme from 'vitepress/theme'
-import { Theme } from 'vitepress'
 import Layout from './Layout.vue'
 import Artalk from './Artalk.vue'
 import Artransfer from './Artransfer.vue'
+import { Theme } from 'vitepress'
 
 export default {
   ...DefaultTheme,
@@ -16,5 +16,5 @@ export default {
     // app is the Vue 3 app instance from `createApp()`.
     // router is VitePress' custom router. `siteData` is
     // a `ref` of current site-level metadata.
-  },
+  }
 } as Theme

docs/.vitepress/theme/style.scss

@@ -8,7 +8,7 @@
   --vp-c-divider: #dfe2e5;
 
   --vp-home-hero-name-color: transparent;
-  --vp-home-hero-name-background: linear-gradient(90deg, #0083ff, #37dfd9);
+  --vp-home-hero-name-background: linear-gradient(90deg,#0083ff, #37dfd9);
 }
 
 .dark {
@@ -38,9 +38,9 @@
   background-color: #0083ff;
 
   &:hover {
-    border-color: #007cf0;
+    border-color: #007CF0;
     color: #fff;
-    background-color: #007cf0;
+    background-color: #007CF0;
   }
 }
 
@@ -48,52 +48,52 @@
 .wave {
   display: inline-block;
   transform-origin: center bottom;
-  animation: upAnimation 2.33s ease 0.8s 3 both;
+  animation:upAnimation 2.33s ease .8s 3 both;
 }
 @keyframes upAnimation {
   0% {
     transform: rotate(0deg);
-    transition-timing-function: cubic-bezier(0.215, 0.61, 0.355, 1);
+    transition-timing-function:cubic-bezier(0.215, .61, .355, 1);
   }
   10% {
     transform: rotate(-12deg);
-    transition-timing-function: cubic-bezier(0.215, 0.61, 0.355, 1);
+    transition-timing-function:cubic-bezier(0.215, .61, .355, 1);
   }
   20% {
     transform: rotate(12deg);
-    transition-timing-function: cubic-bezier(0.215, 0.61, 0.355, 1);
+    transition-timing-function:cubic-bezier(0.215, .61, .355, 1);
   }
   28% {
     transform: rotate(-10deg);
-    transition-timing-function: cubic-bezier(0.215, 0.61, 0.355, 1);
+    transition-timing-function:cubic-bezier(0.215, .61, .355, 1);
   }
   36% {
     transform: rotate(10deg);
-    transition-timing-function: cubic-bezier(0.755, 0.5, 0.855, 0.06);
+    transition-timing-function:cubic-bezier(0.755, .5, .855, .06);
   }
   42% {
     transform: rotate(-8deg);
-    transition-timing-function: cubic-bezier(0.755, 0.5, 0.855, 0.06);
+    transition-timing-function:cubic-bezier(0.755, .5, .855, .06);
   }
   48% {
     transform: rotate(8deg);
-    transition-timing-function: cubic-bezier(0.755, 0.5, 0.855, 0.06);
+    transition-timing-function:cubic-bezier(0.755, .5, .855, .06);
   }
   52% {
     transform: rotate(-4deg);
-    transition-timing-function: cubic-bezier(0.755, 0.5, 0.855, 0.06);
+    transition-timing-function:cubic-bezier(0.755, .5, .855, .06);
   }
   56% {
     transform: rotate(4deg);
-    transition-timing-function: cubic-bezier(0.755, 0.5, 0.855, 0.06);
+    transition-timing-function:cubic-bezier(0.755, .5, .855, .06);
   }
   60% {
     transform: rotate(0deg);
-    transition-timing-function: cubic-bezier(0.755, 0.5, 0.855, 0.06);
+    transition-timing-function:cubic-bezier(0.755, .5, .855, .06);
   }
   100% {
     transform: rotate(0deg);
-    transition-timing-function: cubic-bezier(0.215, 0.61, 0.355, 1);
+    transition-timing-function:cubic-bezier(0.215, .61, .355, 1);
   }
 }
 
@@ -107,38 +107,33 @@ img[atk-emoticon] {
 }
 
 /* 由于 body 未添加一致的 transition，导致其他地方暗黑模式切换加 transition 比较怪 */
-.vp-doc div[class*='language-'] {
-  transition: none;
-}
-.vp-doc :not(pre) > code {
-  transition: none;
-}
+.vp-doc div[class*='language-'] { transition: none; }
+.vp-doc :not(pre) > code { transition: none; }
 
 .vp-doc {
   table {
     border-collapse: collapse;
     margin: 1rem 0;
     display: block;
-    overflow-x: auto;
+    overflow-x: auto
   }
 
-  td,
-  th {
-    padding: 0.6em 1em;
+  td,th {
+    padding: .6em 1em;
   }
 }
 
 /* 侧边栏 */
 .VPSidebar::-webkit-scrollbar {
-  width: 7px;
+  width: 7px
 }
 
 .VPSidebar::-webkit-scrollbar-track {
-  background-color: transparent;
+  background-color: transparent
 }
 
 .VPSidebar::-webkit-scrollbar-thumb {
-  background-color: var(--vp-c-divider);
+  background-color: var(--vp-c-divider)
 }
 
 // details block patch
@@ -151,5 +146,5 @@ img[atk-emoticon] {
 }
 
 .vp-code-group .tabs::after {
-  background-color: var(--vp-c-divider);
+  background-color: var(--vp-c-divider)
 }

docs/.vitepress/types/shims-vue.d.ts

@@ -0,0 +1,5 @@
+declare module '*.vue' {
+  import { defineComponent } from 'vue';
+  const component: ReturnType<typeof defineComponent>;
+  export default component;
+}

docs/README.md

@@ -1,20 +1,19 @@
-# Artalk Documentation
+## Artalk Documentation
 
-[![Netlify Status](https://api.netlify.com/api/v1/badges/6580cce0-4b27-465e-8d73-1e6a832942e9/deploy-status)](https://app.netlify.com/sites/artalk/deploys)
-
-Documentation of Artalk
+> The Documentation of Artalk
 
 ## Build
 
 ```bash
-pnpm dev:docs
-pnpm build:docs
+pnpm docs:dev
+pnpm docs:build
 ```
 
 ## Deploy
 
+[![Netlify Status](https://api.netlify.com/api/v1/badges/6580cce0-4b27-465e-8d73-1e6a832942e9/deploy-status)](https://app.netlify.com/sites/artalk/deploys)
+
 文档通过 [Netlify](https://www.netlify.com/) 对 master 分支进行自动部署。
 
 ## Licensed
-
 CC BY-NC-SA 4.0

docs/code/ArtalkVersion.json

@@ -0,0 +1,3 @@
+{
+  "latest": "2.7.1"
+}

docs/code/quick-start/cdn.html

@@ -1,15 +1,15 @@
 <!-- CSS -->
-<link href="http://localhost:8080/dist/Artalk.css" rel="stylesheet">
+<link href="https://unpkg.com/artalk@2.4.4/dist/Artalk.css" rel="stylesheet">
 
 <!-- JS -->
-<script src="http://localhost:8080/dist/Artalk.js"></script>
+<script src="https://unpkg.com/artalk@2.4.4/dist/Artalk.js"></script>
 
 <!-- Artalk -->
 <div id="Comments"></div>
 <script>
   Artalk.init({
     el:        '#Comments',              // 绑定元素的 Selector
-    pageKey:   '/post/1',                // 固定链接
+    pageKey:   '/post/1',                // 固定链接 (留空自动获取)
     pageTitle: '关于引入 Artalk 这档子事', // 页面标题 (留空自动获取)
     server:    'http://localhost:8080',  // 后端地址
     site:      'Artalk 的博客',           // 你的站点名

docs/develop/api-old.md

@@ -0,0 +1,592 @@
+# HTTP API
+
+::: warning
+该 HTTP API 文档已过时
+:::
+
+::: tip 无特殊说明时 API 调用响应格式
+
+| 字段名 | 类型 | 说明 |
+| ----- | ------- | --- |
+| `success` | Boolean | 接口调用结果 |
+| `msg` | String | 返回消息，出错时此字段包含错误消息 |
+| `data` | Any | 返回数据，可能为 Object / String / Array 类型 |
+
+:::
+
+## Normal API
+
+### 评论新增
+
+**POST** `/api/add`
+
+**参数**
+
+| 字段名 | 数据类型 | 必需 | 说明 |
+| ----- | ------- | :---: | --- |
+| `name` | String | 是 | 待新增评论者昵称 |
+| `email` | String | 是 | 待新增评论者邮箱 |
+| `link` | String | 否 | 待新增评论者链接 |
+| `content` | String | 是 | 待新增评论内容 |
+| `rid` | Number | 否 | 待新增评论为回复评论时传入父评论 `ID`，否则为 `0` |
+| `page_key` | String | 是 | 待新增评论目标页面唯一标识符 |
+| `page_title` | String | 否 | 待新增评论目标页面标题 |
+| `token` | String | 否 | 评论请求 Token |
+| `site_name` | String | 否 | 待新增评论目标站点名称 |
+
+**响应**
+
+| 字段名 | 数据类型 | 默认 | 说明 |
+| ----- | ------- | :-: | --- |
+| `success` | Boolean | `true` | 评论新增成功 |
+| `data.comment` | Object | - | 评论数据 |
+| `data.comment.id` | Number | - | 评论 ID |
+| `data.comment.content` | String | - | 评论正文 |
+| `data.comment.nick` | String | - | 评论者昵称 |
+| `data.comment.email_encrypted` | String | - | 评论者邮箱 MD5 加密值 |
+| `data.comment.link` | String | - | 评论者链接 |
+| `data.comment.ua` | String | - | 评论者 User-Agent |
+| `data.comment.date` | String | - | 评论时间，格式为 `1970-01-01 00:00:00` |
+| `data.comment.is_collapsed` | Boolean | - | 评论是否折叠 |
+| `data.comment.is_pending` | Boolean | - | 评论是否待审 |
+| `data.comment.is_allow_reply` | Boolean | - | 评论是否允许回复 |
+| `data.comment.rid` | Number | `0` | 待新增评论为回复评论时返回父评论 `ID` |
+| `data.comment.badge_name` | String | - | 评论者徽章文字 |
+| `data.comment.badge_color` | String | - | 评论者徽章颜色 |
+| `data.comment.visible` | Boolean | `true` | 评论是否可见 |
+| `data.comment.vote_up` | Number | `0` | 评论赞同数 |
+| `data.comment.vote_down` | Number | `0` | 评论反对数 |
+| `data.comment.page_key` | String | - | 评论所在页面唯一标识符 |
+| `data.comment.site_name` | String | - | 评论所在站点名称 |
+
+### 评论获取
+
+**POST** `/api/get`
+
+**参数**
+
+| 字段名 | 数据类型 | 必需 | 说明 |
+| ----- | ------- | :---: | --- |
+| `page_key` | String | 是 | 待获取评论页面的唯一标识符 |
+| `limit` | Number | 否 | 待获取评论的数量限制 |
+| `offset` | Number | 否 | 待获取评论的起始位置偏移 |
+| `type` | String | 否 | 获取指定类型的评论 |
+| `name` | String | 否 | 获取指定昵称的评论 |
+| `email` | String | 否 | 获取指定邮箱的评论 |
+| `site_name` | String | 否 | 获取指定站点名称的评论 |
+| `flat_mode` | Boolean | 否 | 待获取评论是否平铺模式 |
+
+**响应**
+
+| 字段名 | 数据类型 | 默认 | 说明 |
+| ----- | ------- | :-: | --- |
+| `success` | Boolean | `true` | 评论获取成功 |
+| `data.comments` | Array | - | 页面评论数据 |
+| `data.total` | Number | - | 页面评论总数（包括所有子评论） |
+| `data.total_parents` | Number | - | 页面评论中父级评论总数 |
+| `data.page` | Object | - | 页面数据 |
+| `data.page.id` | Number | - | 页面 ID |
+| `data.page.admin_only` | Boolean | - | 页面是否仅管理员可评论 |
+| `data.page.key` | String | - | 页面唯一标识符 |
+| `data.page.url` | String | - | 页面链接 |
+| `data.page.title` | String | - | 页面标题 |
+| `data.page.site_name` | String | - | 页面所在站点名称 |
+| `data.page.vote_up` | Number | - | 页面赞同数 |
+| `data.page.vote_down` | Number | - | 页面反对数 |
+| `data.unread` | Array | - | 未读的评论提醒数据 |
+| `data.unread_count` | Number | - | 未读的评论提醒数据总数 |
+| `data.api_version` | Object | - | 目标 Artalk 后端版本数据 |
+
+::: tip
+
+ - `data.comments` 数组中元素结构参考 [评论新增接口](#评论新增) `/api/add` 响应的 `data.comment`
+ - `data.unread` 数组中元素结构如下
+    | 字段名 | 数据类型 | 默认 | 说明 |
+    | ----- | ------- | :-: | --- |
+    | `id` | Number | - | 评论提醒 ID |
+    | `user_id` | Number | - | 评论提醒目标用户 ID |
+    | `comment_id` | Number | - | 评论提醒来源评论 ID |
+    | `is_read` | Boolean | - | 评论提醒是否已读 |
+    | `is_emailed` | Boolean | - | 评论提醒是否已发送邮件 |
+    | `read_link` | String | - | 评论提醒已读地址 |
+ - `data.api_version` 对象结构参考 [Artalk 版本接口](#artalk-版本) `/api/version` 响应
+
+:::
+
+### 用户获取
+
+**POST** `/api/user-get`
+
+**参数**
+
+| 字段名 | 数据类型 | 必需 | 说明 |
+| ----- | ------- | :---: | --- |
+| `name` | String | 否 | 待获取用户的昵称 |
+| `email` | String | 否 | 待获取用户的邮箱 |
+
+**响应**
+
+| 字段名 | 数据类型 | 默认 | 说明 |
+| ----- | ------- | :-: | --- |
+| `success` | Boolean | `true` | 用户获取成功 |
+| `data.user` | Object | `null` | 获取的用户数据，若用户不存在返回空 |
+| `data.user.id` | Number | - | 用户 ID |
+| `data.user.name` | String | - | 用户昵称 |
+| `data.user.email` | String | - | 用户邮箱 |
+| `data.user.link` | String | - | 用户链接 |
+| `data.user.badge_name` | String | - | 用户徽章文字 |
+| `data.user.badge_color` | String | - | 用户徽章颜色 |
+| `data.user.is_admin` | Boolean | - | 用户是否管理员 |
+| `data.is_login` | Boolean | - | 用户是否登录 |
+| `data.unread` | Array | `[]` | 用户未读的评论提醒数据 |
+| `data.unread_count` | Number | `0` | 用户未读的评论提醒数据总数 |
+
+::: tip
+
+ - `data.unread` 数组中元素结构参考 [评论获取接口](#评论获取) `/api/get` **TIP**
+
+:::
+
+### 用户登录
+
+**GET/POST** `/api/login`
+
+**参数**
+
+| 字段名 | 数据类型 | 必需 | 说明 |
+| ----- | ------- | :---: | --- |
+| `name` | String | 是 | 待登录用户的昵称 |
+| `email` | String | 是 | 待登录用户的邮箱 |
+| `password` | String | 是 | 待登录用户的密码（管理员身份验证） |
+
+**响应**
+
+| 字段名 | 数据类型 | 默认 | 说明 |
+| ----- | ------- | :-: | --- |
+| `success` | Boolean | `true` | 用户登录成功 |
+| `data.token` | String | - | 登录的用户 Token |
+
+### 提醒已读
+
+**POST** `/api/mark-read`
+
+**参数**
+
+| 字段名 | 数据类型 | 必需 | 说明 |
+| ----- | ------- | :---: | --- |
+| `notify_key` | String | 否 | 评论提醒唯一标识符 |
+| `name` | String | 否 | 评论提醒用户的昵称 |
+| `email` | String | 否 | 评论提醒用户的邮箱 |
+| `all_read` | Boolean | 否 | 评论提醒是否已读 |
+| `site_name` | String | 否 | 评论提醒所在站点名称 |
+
+**响应**
+
+| 字段名 | 数据类型 | 默认 | 说明 |
+| ----- | ------- | :-: | --- |
+| `success` | Boolean | `true` | 提醒已读成功 |
+
+### 评论投票
+
+**POST** `/api/vote`
+
+**参数**
+
+| 字段名 | 数据类型 | 必需 | 说明 |
+| ----- | ------- | :---: | --- |
+| `target_id` | Number | 是 | 待投票评论 ID |
+| `type` | String | 否 | 待投票类型，前缀 `comment_`、`page_` 依次代表对评论投票、对页面投票，后缀 `_up`、`_down` 依次代表赞同、反对 |
+| `name` | String | 否 | 投票用户昵称 |
+| `email` | String | 否 | 投票用户邮箱 |
+| `site_name` | String | 否 | 投票目标评论或页面所在站点名称 |
+
+**响应**
+
+| 字段名 | 数据类型 | 默认 | 说明 |
+| ----- | ------- | :-: | --- |
+| `success` | Boolean | `true` | 评论投票成功 |
+| `data.vote_num` | Number | - | 目标评论或页面指定类型投票数据 |
+
+### Artalk 版本
+
+::: warning
+
+此接口较特殊，返回结果不包含 `success`、`msg`、`data` 字段，直接返回包含指定字段的 JSON。
+
+:::
+
+**GET/POST** `/api/version`
+
+**参数** 无
+
+**响应**
+
+| 字段名 | 数据类型 | 默认 | 说明 |
+| ----- | ------- | :-: | --- |
+| `app` | String | `artalk` | Artalk 后端程序名 |
+| `version` | String | - | Artalk 后端程序版本号 |
+| `commit_hash` | String | - | Artalk 后端程序 Git 提交哈希值 |
+| `fe_min_version` | String | - | Artalk 后端程序所需前端最低版本 |
+
+## Captcha API
+
+### 验证码刷新
+
+**GET** `/api/captcha/refresh`
+
+**参数** 无
+
+**响应**
+
+| 字段名 | 数据类型 | 默认 | 说明 |
+| ----- | ------- | :-: | --- |
+| `success` | Boolean | `true` | 验证码刷新成功 |
+| `data.img_data` | String | - | 根据 IP 获取的验证码图片 Base64 编码 |
+
+### 验证码检验
+
+**GET** `/api/captcha/check`
+
+**参数**
+
+| 字段名 | 数据类型 | 必需 | 说明 |
+| ----- | ------- | :---: | --- |
+| `value` | String | 是 | 验证码 |
+
+**响应**
+
+| 字段名 | 数据类型 | 默认 | 说明 |
+| ----- | ------- | :-: | --- |
+| `success` | Boolean | `true` | 验证码检验成功 |
+| `data.img_data` | String | - | 新的验证码图片 Base64 编码，仅验证码检验出错时存在此字段 |
+
+## Admin API
+
+### 评论编辑
+
+**POST** `/api/admin/comment-edit`
+
+**参数**
+
+| 字段名 | 数据类型 | 必需 | 说明 |
+| ----- | ------- | :---: | --- |
+| `id` | Number | 是 | 待编辑评论 ID，**不可修改** |
+| `site_name` | String | 否 | 待编辑评论所在站点名称，**不可修改** |
+| `content` | String | 否 | 待编辑评论正文 |
+| `page_key` | String | 否 | 待编辑评论所在页面唯一标识符 |
+| `nick` | String | 否 | 待编辑评论所属用户昵称 |
+| `email` | String | 否 | 待编辑评论所属用户邮箱 |
+| `link` | String | 否 | 待编辑评论所属用户链接 |
+| `rid` | String | 否 | 待编辑评论为回复评论时传入父评论 `ID`，否则为 `0` |
+| `ua` | String | 否 | 待编辑评论所属用户 User-Agent |
+| `ip` | String | 否 | 待编辑评论所属用户 IP |
+| `is_collapsed` | Boolean | 否 | 待编辑评论是否折叠 |
+| `is_pending` | Boolean | 否 | 待编辑评论是否待审 |
+
+**响应**
+
+| 字段名 | 数据类型 | 默认 | 说明 |
+| ----- | ------- | :-: | --- |
+| `success` | Boolean | `true` | 评论编辑成功 |
+| `data.comment` | Object | - | 编辑评论的新数据 |
+
+::: tip
+
+ - `data.comment` 对象结构参考 [评论新增接口](#评论新增) `/api/add` 响应的 `data.comment`
+
+:::
+
+### 评论删除
+
+::: danger
+
+此接口不推荐外部调用。
+
+调用此接口前请务必核实评论 ID，一旦调用成功将删除该评论下所有相关数据。
+
+:::
+
+**POST** `/api/admin/comment-del`
+
+**参数**
+
+| 字段名 | 数据类型 | 必需 | 说明 |
+| ----- | ------- | :---: | --- |
+| `id` | Number | 是 | 待删除评论 ID |
+| `site_name` | String | 是 | 待删除评论所在站点名称 |
+
+**响应**
+
+| 字段名 | 数据类型 | 默认 | 说明 |
+| ----- | ------- | :-: | --- |
+| `success` | Boolean | `true` | 评论删除成功 |
+
+### 页面获取
+
+**POST** `/api/admin/page-get`
+
+**参数**
+
+| 字段名 | 数据类型 | 必需 | 说明 |
+| ----- | ------- | :---: | --- |
+| `site_name` | String | 是 | 待获取页面目标站点名称 |
+
+**响应**
+
+| 字段名 | 数据类型 | 默认 | 说明 |
+| ----- | ------- | :-: | --- |
+| `success` | Boolean | `true` | 页面获取成功 |
+| `data.pages` | Array | - | 目标站点的页面数据 |
+| `data.sites` | Array | - | 所有站点数据 |
+
+::: tip
+
+ - `data.pages` 数组中元素结构参考 [评论获取接口](#评论获取) `/api/get` 响应的 `data.page`
+ - `data.sites` 数组中元素结构参考 [站点编辑接口](#站点编辑) `/api/admin/site-edit` 响应的 `data.site`
+
+:::
+
+### 页面编辑
+
+**POST** `/api/admin/page-edit`
+
+**参数**
+
+| 字段名 | 数据类型 | 必需 | 说明 |
+| ----- | ------- | :---: | --- |
+| `id` | Number | 是 | 待编辑页面 ID，**不可修改** |
+| `site_name` | String | 否 | 待编辑页面所在站点名称，**不可修改** |
+| `key` | String | 否 | 待编辑页面唯一标识符 |
+| `title` | String | 否 | 待编辑页面标题 |
+| `admin_only` | Boolean | 否 | 待编辑页面是否仅管理员可评论 |
+
+**响应**
+
+| 字段名 | 数据类型 | 默认 | 说明 |
+| ----- | ------- | :-: | --- |
+| `success` | Boolean | `true` | 页面编辑成功 |
+| `data.page` | Object | - | 编辑页面的新数据 |
+
+::: tip
+
+ - `data.page` 对象结构参考 [评论获取接口](#评论获取) `/api/get` 响应的 `data.page`
+
+:::
+
+### 页面删除
+
+::: danger
+
+此接口不推荐外部调用。
+
+调用此接口前请务必核实页面 ID，一旦调用成功将删除该页面下所有相关数据。
+
+:::
+
+**POST** `/api/admin/page-del`
+
+**参数**
+
+| 字段名 | 数据类型 | 必需 | 说明 |
+| ----- | ------- | :---: | --- |
+| `key` | String | 是 | 待删除页面唯一标识符 |
+| `site_name` | String | 是 | 待删除页面所在站点名称 |
+
+**响应**
+
+| 字段名 | 数据类型 | 默认 | 说明 |
+| ----- | ------- | :-: | --- |
+| `success` | Boolean | `true` | 页面删除成功 |
+
+### 页面更新
+
+**POST** `/api/admin/page-fetch`
+
+**参数**
+
+| 字段名 | 数据类型 | 必需 | 说明 |
+| ----- | ------- | :---: | --- |
+| `id` | Number | 是 | 待更新页面 ID |
+
+**响应**
+
+| 字段名 | 数据类型 | 默认 | 说明 |
+| ----- | ------- | :-: | --- |
+| `success` | Boolean | `true` | 页面更新成功 |
+| `data.page` | Object | - | 更新页面的新数据 |
+
+::: tip
+
+ - `data.page` 对象结构参考 [评论获取接口](#评论获取) `/api/get` 响应的 `data.page`
+
+:::
+
+### 站点获取
+
+**POST** `/api/admin/site-get`
+
+**参数** 无
+
+**响应**
+
+| 字段名 | 数据类型 | 默认 | 说明 |
+| ----- | ------- | :-: | --- |
+| `success` | Boolean | `true` | 站点获取成功 |
+| `data.sites` | Array | - | 所有站点数据 |
+
+::: tip
+
+ - `data.sites` 数组中元素结构参考 [站点编辑接口](#站点编辑) `/api/admin/site-edit` 响应的 `data.site`
+
+:::
+
+### 站点新增
+
+**POST** `/api/admin/site-add`
+
+**参数**
+
+| 字段名 | 数据类型 | 必需 | 说明 |
+| ----- | ------- | :---: | --- |
+| `name` | String | 是 | 待新增站点名称 |
+| `urls` | String | 是 | 待新增站点链接，如有多个需以英文半角符号 `,` 分割 |
+
+**响应**
+
+| 字段名 | 数据类型 | 默认 | 说明 |
+| ----- | ------- | :-: | --- |
+| `success` | Boolean | `true` | 站点新增成功 |
+| `data.site` | Object | - | 新增站点的数据 |
+| `data.site.id` | Number | - | 站点 ID |
+| `data.site.name` | String | - | 站点名称 |
+| `data.site.urls` | Array | - | 站点链接数组，元素为单个站点链接字符串 |
+| `data.site.urls_raw` | String | - | 站点链接数组合并字符串，以英文半角符号 `,` 分割 |
+| `data.site.first_url` | String | - | 站点第一链接 |
+
+### 站点编辑
+
+**POST** `/api/admin/site-edit`
+
+**参数**
+
+| 字段名 | 数据类型 | 必需 | 说明 |
+| ----- | ------- | :---: | --- |
+| `id` | Number | 是 | 待编辑站点 ID |
+| `name` | String | 是 | 待编辑站点新名称 |
+| `urls` | String | 是 | 待编辑站点新链接 |
+
+**响应**
+
+| 字段名 | 数据类型 | 默认 | 说明 |
+| ----- | ------- | :-: | --- |
+| `success` | Boolean | `true` | 站点编辑成功 |
+| `data.site` | Object | - | 编辑站点的新数据 |
+| `data.site.id` | Number | - | 站点 ID |
+| `data.site.name` | String | - | 站点名称 |
+| `data.site.urls` | Array | - | 站点链接数组，元素为单个站点链接字符串 |
+| `data.site.urls_raw` | String | - | 站点链接数组合并字符串，以英文半角符号 `,` 分割 |
+| `data.site.first_url` | String | - | 站点第一链接 |
+
+### 站点删除
+
+::: danger
+
+此接口不推荐外部调用。
+
+调用此接口前请务必核实站点 ID，一旦调用成功将删除该站点下所有相关数据。
+
+:::
+
+**POST** `/api/admin/site-del`
+
+**参数**
+
+| 字段名 | 数据类型 | 必需 | 说明 |
+| ----- | ------- | :---: | --- |
+| `id` | Number | 是 | 待删除站点 ID |
+| `del_content` | Boolean | 否 | 是否删除站点所有数据，为 `false` 时仅删除站点配置而保留站点评论数据 |
+
+**响应**
+
+| 字段名 | 数据类型 | 默认 | 说明 |
+| ----- | ------- | :-: | --- |
+| `success` | Boolean | `true` | 站点删除成功 |
+
+### 设置获取
+
+**POST** `/api/admin/setting-get`
+
+**参数**
+
+| 字段名 | 数据类型 | 必需 | 说明 |
+| ----- | ------- | :---: | --- |
+| `id` | Number | 是 | 管理员用户 ID |
+| `name` | String | 否 | 管理员用户昵称 |
+| `url` | String | 否 | 管理员用户链接 |
+
+**响应**
+
+| 字段名 | 数据类型 | 默认 | 说明 |
+| ----- | ------- | :-: | --- |
+| `success` | Boolean | `true` | 设置获取成功 |
+
+### 设置保存
+
+**POST** `/api/admin/setting-save`
+
+**参数**
+
+| 字段名 | 数据类型 | 必需 | 说明 |
+| ----- | ------- | :---: | --- |
+| `id` | Number | 是 | 管理员用户 ID |
+| `name` | String | 否 | 管理员用户昵称 |
+| `url` | String | 否 | 管理员用户链接 |
+
+**响应**
+
+| 字段名 | 数据类型 | 默认 | 说明 |
+| ----- | ------- | :-: | --- |
+| `success` | Boolean | `true` | 设置保存成功 |
+
+### 邮件发送
+
+::: warning
+
+页面收到评论、评论收到回复等满足需要发送邮件提醒条件时，后端将自动向目标地址发送邮件提醒，不需手动处理邮件发送。请勿滥用此接口。
+
+:::
+
+**POST** `/api/admin/send-mail`
+
+**参数**
+
+| 字段名 | 数据类型 | 必需 | 说明 |
+| ----- | ------- | :---: | --- |
+| `subject` | String | 是 | 邮件主题 |
+| `body` | String | 是 | 邮件正文 |
+| `to_addr` | String | 是 | 邮件收件人 |
+
+**响应**
+
+| 字段名 | 数据类型 | 默认 | 说明 |
+| ----- | ------- | :-: | --- |
+| `success` | Boolean | `true` | 邮件发送成功 |
+
+### Artrans 接口
+
+::: warning
+
+此接口暂不稳定，请避免使用！
+
+:::
+
+**POST** `/api/admin/artransfer`
+
+**参数**
+
+| 字段名 | 数据类型 | 必需 | 说明 |
+| ----- | ------- | :---: | --- |
+| `type` | String | 是 | 导入数据类型 |
+| `payload` | String | 否 | 导入数据 |
+
+**响应** 无

docs/develop/event.md

@@ -0,0 +1,50 @@
+# Event
+
+## 基本事件
+
+|事件名|描述|
+|-|-|
+| `inited` | 初始化后 |
+| `destroy` | 实例销毁时 |
+| `list-fetch` | 评论列表请求时 |
+| `list-fetched` | 评论列表请求后 |
+| `list-load` | 评论装载前 |
+| `list-loaded` | 评论装载后 |
+| `list-error` | 评论加载错误时 |
+| `list-goto-first` | 评论列表归位时 |
+| `list-reach-bottom` | 评论列表滚动到底部时 |
+| `list-reach-bottom` | 评论列表滚动到底部时 |
+| `comment-inserted`   | 评论插入后           |
+| `comment-updated`    | 评论更新后           |
+| `comment-deleted`    | 评论删除后           |
+| `comment-rendered`   | 评论节点渲染后       |
+| `unreads-updated`    | 未读消息变更时       |
+| `list-goto`          | 评论跳转时           |
+| `page-loaded`        | 页面数据更新后       |
+| `editor-submit`      | 编辑器提交时         |
+| `editor-submitted`   | 编辑器提交后         |
+| `user-changed`       | 本地用户数据变更时   |
+| `conf-loaded`        | 配置变更时           |
+| `dark-mode-changed`  | 深色模式变更时       |
+| `sidebar-show`       | 侧边栏显示          |
+| `sidebar-hide`       | 侧边栏隐藏          |
+ 
+
+事件声明代码：[@ArtalkJS/Artalk - types/event.ts](https://github.com/ArtalkJS/Artalk/blob/master/ui/packages/artalk/types/event.ts)
+
+## 添加事件监听
+
+```js
+artalk.on('list-loaded', () => {
+  alert('评论已加载完毕')
+})
+```
+
+## 解除事件监听
+
+```js
+let foo = function() { /* do something */ }
+
+artalk.on('list-loaded', foo)
+artalk.off('list-loaded', foo)
+```

docs/develop/fe-api.md

@@ -14,8 +14,6 @@ npm install artalk
 
 调用该函数将创建并得到一个 Artalk 的实例化对象，可用于后续操作。
 
-<!-- prettier-ignore-start -->
-
 ```js
 import Artalk from 'artalk'
 
@@ -28,18 +26,14 @@ const artalk = Artalk.init({
 })
 ```
 
-<!-- prettier-ignore-end -->
-
-调用该函数会异步地向后端发起请求：
+调用该函数会向后端发起请求：
 
 1. 获取前端配置
 2. 获取评论列表
 
-配置和插件加载完毕后会触发 `mounted` 事件。
+配置和评论加载完毕后会分别触发 `conf-loaded` 和 `list-loaded` 事件。
 
-评论列表加载完毕后会触发 `list-loaded` 事件。
-
-> 注：前端界面配置可能会被覆盖，详情见：[界面配置](../guide/frontend/config.md)。
+注：前端配置可能会被覆盖，详情见：[在后端控制前端](../guide/backend/fe-control.md)。
 
 ## 释放资源 `destroy`
 
@@ -51,7 +45,7 @@ const artalk = Artalk.init({ ... })
 artalk.destroy()
 ```
 
-调用该函数时，将触发 `unmounted` 事件。释放资源将执行 Artalk 挂载的 DOM 节点删除，以及解除 Artalk 事件监听等操作。当该函数执行完毕后，Artalk 实例将不再可用。
+释放资源将执行 Artalk 挂载的 DOM 节点删除，以及解除 Artalk 事件监听等操作。
 
 在 Vue / React 等框架中，务必在组件销毁时调用该函数，否则会造成内存泄漏：
 
@@ -75,11 +69,11 @@ artalk.update({
 })
 ```
 
-调用该函数将触发 `updated` 事件。
+调用该函数将触发 `conf-loaded` 事件。
 
 更新配置不会自动刷新评论列表，可按需继续执行 `artalk.reload()` 函数。
 
-请注意，该函数是一个实例化对象中的成员方法，并非全局函数。
+请注意，该函数是一个实例化对象中的方法，并非全局函数。
 
 前端配置参考：[前端配置](../guide/frontend/config.md)
 
@@ -102,9 +96,8 @@ artalk.reload()
 ```js
 const artalk = Artalk.init({ ... })
 
-artalk.on('list-loaded', (comments) => {
-  // comments 包含当前页面所有评论数据 (而非仅本次请求获取的部分评论)
-  console.log('评论列表加载完毕: ', comments)
+artalk.on('list-loaded', () => {
+  alert('评论列表加载完毕')
 })
 ```
 
@@ -132,7 +125,7 @@ artalk.off('list-loaded', handler)
 ```js
 const artalk = Artalk.init({ ... })
 
-artalk.trigger('list-loaded', [...])
+artalk.trigger('list-loaded')
 ```
 
 ## 加载插件 `use`
@@ -149,7 +142,7 @@ Artalk.use((ctx) => {
 const artalk = Artalk.init({ ... })
 ```
 
-详情见：[插件开发](./plugin.md)
+详情见：[插件开发](./plugs.md)
 
 ## 夜间模式 `setDarkMode`
 
@@ -161,35 +154,6 @@ const artalk = Artalk.init({ ... })
 artalk.setDarkMode(true)
 ```
 
-也可以通过调用 `Artalk.init` 时，通过 `darkMode` 参数设置初始夜间模式。
-
-```js
-const artalk = Artalk.init({
-  // ...其他配置
-  darkMode: 'auto',
-})
-```
-
 ## 浏览量组件 `loadCountWidget`
 
 详情见：[浏览量统计](../guide/frontend/pv.md)
-
-## 获取配置 `getConf`
-
-获取当前 Artalk 配置。
-
-```js
-const artalk = Artalk.init({ ... })
-
-const conf = artalk.getConf()
-```
-
-## 获取挂载元素 `getEl`
-
-获取当前 Artalk 挂载的 DOM 元素。
-
-```js
-const artalk = Artalk.init({ ... })
-
-const el = artalk.getEl()
-```

docs/develop/index.md

@@ -0,0 +1,28 @@
+# 开发说明
+
+## 参考资源
+
+📖 <a href="https://github.com/ArtalkJS/Artalk/blob/master/CONTRIBUTING.md" target="_blank">开发者贡献指南 (CONTRIBUTING.md)</a>
+
+🔬 <a href="/http-api.html" target="_blank">HTTP API 文档 (OpenAPI)</a>
+
+🔖 <a href="https://github.com/ArtalkJS/Artalk/blob/master/CODE_OF_CONDUCT.md" target="_blank">贡献者契约行为准则 (CODE_OF_CONDUCT.md)</a>
+
+
+## 配置文档
+
+- [后端配置](../guide/backend/config.md)
+- [前端配置](../guide/frontend/config.md)
+
+## 补充说明
+
+由于 Artalk 正处于开发阶段，使用此文档中 `API`、`Event` 前请务必检查时效性。
+
+ - `API` 部分参考源码
+   * [@ArtalkJS/Artalk - src/api/](https://github.com/ArtalkJS/Artalk/tree/master/ui/packages/artalk/src/api)
+   * [@ArtalkJS/Artalk - server/server.go](https://github.com/ArtalkJS/Artalk/blob/master/server/server.go)
+ - `UI` 及 `Event` 部分参考源码
+   * [@ArtalkJS/Artalk - src/artalk.ts](https://github.com/ArtalkJS/Artalk/blob/master/ui/packages/artalk/src/artalk.ts)
+   * [@ArtalkJS/Artalk - types/event.ts](https://github.com/ArtalkJS/Artalk/blob/master/ui/packages/artalk/types/event.ts)
+
+通过 Artalk 提供的 `API` 和 `Event`，你可以实现很多高级功能，比如编写评论管理机器人、评论提醒推送插件等。Artalk 并不为此提供技术指导，但鼓励你参考此处的文档自行定制。

docs/develop/plugs.md

@@ -0,0 +1,64 @@
+# 插件开发
+
+使用 `Artalk.use` 来扩展 Artalk。
+
+```js
+import Artalk from 'artalk'
+
+Artalk.use((ctx) => {
+  ctx.on('inited', () => {
+    ctx.get('editor').setContent("Hello World")
+  })
+
+  ctx.on('list-loaded', () => {
+    console.log('评论列表加载完毕')
+  })
+})
+
+const artalk = Artalk.init({ ... })
+```
+
+请注意：
+
+- `Artalk.use` 必须在 `Artalk.init` 之前调用。
+- 请勿依赖插件的加载顺序，请监听事件来执行插件逻辑。
+- 当所有的插件加载完毕后，会触发 `inited` 事件。
+
+在 use 函数中，你可以通过 `ctx` 来访问 Artalk 的上下文。
+
+## Context
+
+Context 对象包含了 Artalk 的上下文信息。
+
+| 成员 | 说明 |
+| --- | --- |
+| `ctx.$root` | Artalk 容器元素 |
+| `ctx.conf` | Artalk 配置 |
+| `ctx.fetch` | 加载数据数据 |
+| `ctx.reload` | 重载评论列表 |
+| `ctx.on` | 添加事件监听 |
+| `ctx.off` | 解除事件监听 |
+| `ctx.trigger` | 触发事件 |
+| `ctx.inject` | 依赖注入 |
+| `ctx.get` | 获取依赖 |
+
+::: warning
+Context API 目前仍不稳定，开发可能会有变动，升级请关注 CHANGELOG。
+:::
+
+参考：[@artalk/types/context.ts](https://github.com/ArtalkJS/Artalk/blob/master/ui/packages/artalk/types/context.ts)
+
+Artalk 拥有完整的 TypeScript 类型定义，你可以通过编辑器的自动补全来查看 API。
+
+## 示例插件
+
+Artalk 有很多内置的插件，你可以参考它们的源码来开发自己的插件。
+
+[@ArtalkJS/Artalk - src/plugins](https://github.com/ArtalkJS/Artalk/tree/master/ui/packages/artalk/src/plugins)
+
+我们还提供了一些外置的插件，同样可以参考：
+
+| 插件 | 说明 |
+| --- | --- |
+| [@artalk/plugin-katex](https://github.com/ArtalkJS/Artalk/tree/master/ui/packages/plugin-katex) | LaTeX 公式插件 |
+| [@artalk/plugin-lightbox](https://github.com/ArtalkJS/Artalk/tree/master/ui/packages/plugin-lightbox) | 图片灯箱插件 |

docs/docs/.gitignore

@@ -1,2 +0,0 @@
-.vitepress/dist/**
-.vitepress/cache/**

docs/docs/.vitepress/theme/Artalk.vue

@@ -1,82 +0,0 @@
-<template>
-  <div ref="el" style="margin-top: 20px"></div>
-</template>
-
-<script setup lang="ts">
-import { watch, nextTick, ref, onMounted, onUnmounted } from 'vue'
-import { useData, useRouter } from 'vitepress'
-import Artalk from 'artalk'
-import { ArtalkKatexPlugin } from '@artalk/plugin-katex'
-import { ArtalkLightboxPlugin } from '@artalk/plugin-lightbox'
-import 'lightgallery/css/lightgallery.css'
-import 'katex/dist/katex.min.css'
-import 'artalk/dist/Artalk.css'
-
-const el = ref<HTMLElement | null>(null)
-
-const router = useRouter()
-const page = useData().page
-
-let artalk: Artalk
-
-onMounted(() => {
-  nextTick(() => {
-    initArtalk(getConfByPage())
-  })
-})
-
-watch(
-  () => router.route.path,
-  () => {
-    nextTick(() => {
-      artalk.update(getConfByPage())
-      artalk.reload()
-    })
-  },
-)
-
-onUnmounted(() => {
-  artalk.destroy()
-})
-
-function initArtalk(conf: any) {
-  Artalk.use(ArtalkKatexPlugin)
-  Artalk.use(ArtalkLightboxPlugin, {
-    lightGallery: {
-      lib: async () => (await import('lightgallery')).default
-    }
-  })
-
-  artalk = Artalk.init({
-    el: el.value,
-    emoticons: '/assets/emoticons/default.json',
-    ...conf,
-  })
-
-  loadExtraFuncs()
-}
-
-function getConfByPage() {
-  return {
-    pageKey: 'https://artalk.js.org' + router.route.path,
-    pageTitle: page.value.title,
-    server: 'https://artalk.qwqaq.com',
-    site: 'ArtalkDocs',
-  }
-}
-
-function loadExtraFuncs() {
-  // 夜间模式
-  const darkMode = document.querySelector('html').classList.contains('dark')
-  artalk.setDarkMode(darkMode)
-
-  new MutationObserver((mList) => {
-    mList.forEach((m) => {
-      if (m.attributeName !== 'class') return
-
-      const darkMode = (<HTMLElement>m.target).classList.contains('dark')
-      artalk.setDarkMode(darkMode)
-    })
-  }).observe(document.querySelector('html'), { attributes: true })
-}
-</script>

docs/docs/.vitepress/types/shims-vue.d.ts

@@ -1,5 +0,0 @@
-declare module '*.vue' {
-  import { defineComponent } from 'vue'
-  const component: ReturnType<typeof defineComponent>
-  export default component
-}

docs/docs/code/ArtalkVersion.json

@@ -1,3 +0,0 @@
-{
-  "latest": "2.9.0"
-}

docs/docs/develop/api-old.md

@@ -1,592 +0,0 @@
-# HTTP API
-
-::: warning
-该 HTTP API 文档已过时
-:::
-
-::: tip 无特殊说明时 API 调用响应格式
-
-| 字段名    | 类型    | 说明                                          |
-| --------- | ------- | --------------------------------------------- |
-| `success` | Boolean | 接口调用结果                                  |
-| `msg`     | String  | 返回消息，出错时此字段包含错误消息            |
-| `data`    | Any     | 返回数据，可能为 Object / String / Array 类型 |
-
-:::
-
-## Normal API
-
-### 评论新增
-
-**POST** `/api/add`
-
-**参数**
-
-| 字段名       | 数据类型 | 必需 | 说明                                              |
-| ------------ | -------- | :--: | ------------------------------------------------- |
-| `name`       | String   |  是  | 待新增评论者昵称                                  |
-| `email`      | String   |  是  | 待新增评论者邮箱                                  |
-| `link`       | String   |  否  | 待新增评论者链接                                  |
-| `content`    | String   |  是  | 待新增评论内容                                    |
-| `rid`        | Number   |  否  | 待新增评论为回复评论时传入父评论 `ID`，否则为 `0` |
-| `page_key`   | String   |  是  | 待新增评论目标页面唯一标识符                      |
-| `page_title` | String   |  否  | 待新增评论目标页面标题                            |
-| `token`      | String   |  否  | 评论请求 Token                                    |
-| `site_name`  | String   |  否  | 待新增评论目标站点名称                            |
-
-**响应**
-
-| 字段名                         | 数据类型 |  默认  | 说明                                   |
-| ------------------------------ | -------- | :----: | -------------------------------------- |
-| `success`                      | Boolean  | `true` | 评论新增成功                           |
-| `data.comment`                 | Object   |   -    | 评论数据                               |
-| `data.comment.id`              | Number   |   -    | 评论 ID                                |
-| `data.comment.content`         | String   |   -    | 评论正文                               |
-| `data.comment.nick`            | String   |   -    | 评论者昵称                             |
-| `data.comment.email_encrypted` | String   |   -    | 评论者邮箱 SHA256 加密值                |
-| `data.comment.link`            | String   |   -    | 评论者链接                             |
-| `data.comment.ua`              | String   |   -    | 评论者 User-Agent                      |
-| `data.comment.date`            | String   |   -    | 评论时间，格式为 `1970-01-01 00:00:00` |
-| `data.comment.is_collapsed`    | Boolean  |   -    | 评论是否折叠                           |
-| `data.comment.is_pending`      | Boolean  |   -    | 评论是否待审                           |
-| `data.comment.is_allow_reply`  | Boolean  |   -    | 评论是否允许回复                       |
-| `data.comment.rid`             | Number   |  `0`   | 待新增评论为回复评论时返回父评论 `ID`  |
-| `data.comment.badge_name`      | String   |   -    | 评论者徽章文字                         |
-| `data.comment.badge_color`     | String   |   -    | 评论者徽章颜色                         |
-| `data.comment.visible`         | Boolean  | `true` | 评论是否可见                           |
-| `data.comment.vote_up`         | Number   |  `0`   | 评论赞同数                             |
-| `data.comment.vote_down`       | Number   |  `0`   | 评论反对数                             |
-| `data.comment.page_key`        | String   |   -    | 评论所在页面唯一标识符                 |
-| `data.comment.site_name`       | String   |   -    | 评论所在站点名称                       |
-
-### 评论获取
-
-**POST** `/api/get`
-
-**参数**
-
-| 字段名      | 数据类型 | 必需 | 说明                       |
-| ----------- | -------- | :--: | -------------------------- |
-| `page_key`  | String   |  是  | 待获取评论页面的唯一标识符 |
-| `limit`     | Number   |  否  | 待获取评论的数量限制       |
-| `offset`    | Number   |  否  | 待获取评论的起始位置偏移   |
-| `type`      | String   |  否  | 获取指定类型的评论         |
-| `name`      | String   |  否  | 获取指定昵称的评论         |
-| `email`     | String   |  否  | 获取指定邮箱的评论         |
-| `site_name` | String   |  否  | 获取指定站点名称的评论     |
-| `flat_mode` | Boolean  |  否  | 待获取评论是否平铺模式     |
-
-**响应**
-
-| 字段名                 | 数据类型 |  默认  | 说明                           |
-| ---------------------- | -------- | :----: | ------------------------------ |
-| `success`              | Boolean  | `true` | 评论获取成功                   |
-| `data.comments`        | Array    |   -    | 页面评论数据                   |
-| `data.total`           | Number   |   -    | 页面评论总数（包括所有子评论） |
-| `data.total_parents`   | Number   |   -    | 页面评论中父级评论总数         |
-| `data.page`            | Object   |   -    | 页面数据                       |
-| `data.page.id`         | Number   |   -    | 页面 ID                        |
-| `data.page.admin_only` | Boolean  |   -    | 页面是否仅管理员可评论         |
-| `data.page.key`        | String   |   -    | 页面唯一标识符                 |
-| `data.page.url`        | String   |   -    | 页面链接                       |
-| `data.page.title`      | String   |   -    | 页面标题                       |
-| `data.page.site_name`  | String   |   -    | 页面所在站点名称               |
-| `data.page.vote_up`    | Number   |   -    | 页面赞同数                     |
-| `data.page.vote_down`  | Number   |   -    | 页面反对数                     |
-| `data.unread`          | Array    |   -    | 未读的评论提醒数据             |
-| `data.unread_count`    | Number   |   -    | 未读的评论提醒数据总数         |
-| `data.api_version`     | Object   |   -    | 目标 Artalk 后端版本数据       |
-
-::: tip
-
-- `data.comments` 数组中元素结构参考 [评论新增接口](#评论新增) `/api/add` 响应的 `data.comment`
-- `data.unread` 数组中元素结构如下
-  | 字段名 | 数据类型 | 默认 | 说明 |
-  | ----- | ------- | :-: | --- |
-  | `id` | Number | - | 评论提醒 ID |
-  | `user_id` | Number | - | 评论提醒目标用户 ID |
-  | `comment_id` | Number | - | 评论提醒来源评论 ID |
-  | `is_read` | Boolean | - | 评论提醒是否已读 |
-  | `is_emailed` | Boolean | - | 评论提醒是否已发送邮件 |
-  | `read_link` | String | - | 评论提醒已读地址 |
-- `data.api_version` 对象结构参考 [Artalk 版本接口](#artalk-版本) `/api/version` 响应
-
-:::
-
-### 用户获取
-
-**POST** `/api/user-get`
-
-**参数**
-
-| 字段名  | 数据类型 | 必需 | 说明             |
-| ------- | -------- | :--: | ---------------- |
-| `name`  | String   |  否  | 待获取用户的昵称 |
-| `email` | String   |  否  | 待获取用户的邮箱 |
-
-**响应**
-
-| 字段名                  | 数据类型 |  默认  | 说明                               |
-| ----------------------- | -------- | :----: | ---------------------------------- |
-| `success`               | Boolean  | `true` | 用户获取成功                       |
-| `data.user`             | Object   | `null` | 获取的用户数据，若用户不存在返回空 |
-| `data.user.id`          | Number   |   -    | 用户 ID                            |
-| `data.user.name`        | String   |   -    | 用户昵称                           |
-| `data.user.email`       | String   |   -    | 用户邮箱                           |
-| `data.user.link`        | String   |   -    | 用户链接                           |
-| `data.user.badge_name`  | String   |   -    | 用户徽章文字                       |
-| `data.user.badge_color` | String   |   -    | 用户徽章颜色                       |
-| `data.user.is_admin`    | Boolean  |   -    | 用户是否管理员                     |
-| `data.is_login`         | Boolean  |   -    | 用户是否登录                       |
-| `data.unread`           | Array    |  `[]`  | 用户未读的评论提醒数据             |
-| `data.unread_count`     | Number   |  `0`   | 用户未读的评论提醒数据总数         |
-
-::: tip
-
-- `data.unread` 数组中元素结构参考 [评论获取接口](#评论获取) `/api/get` **TIP**
-
-:::
-
-### 用户登录
-
-**GET/POST** `/api/login`
-
-**参数**
-
-| 字段名     | 数据类型 | 必需 | 说明                               |
-| ---------- | -------- | :--: | ---------------------------------- |
-| `name`     | String   |  是  | 待登录用户的昵称                   |
-| `email`    | String   |  是  | 待登录用户的邮箱                   |
-| `password` | String   |  是  | 待登录用户的密码（管理员身份验证） |
-
-**响应**
-
-| 字段名       | 数据类型 |  默认  | 说明             |
-| ------------ | -------- | :----: | ---------------- |
-| `success`    | Boolean  | `true` | 用户登录成功     |
-| `data.token` | String   |   -    | 登录的用户 Token |
-
-### 提醒已读
-
-**POST** `/api/mark-read`
-
-**参数**
-
-| 字段名       | 数据类型 | 必需 | 说明                 |
-| ------------ | -------- | :--: | -------------------- |
-| `notify_key` | String   |  否  | 评论提醒唯一标识符   |
-| `name`       | String   |  否  | 评论提醒用户的昵称   |
-| `email`      | String   |  否  | 评论提醒用户的邮箱   |
-| `all_read`   | Boolean  |  否  | 评论提醒是否已读     |
-| `site_name`  | String   |  否  | 评论提醒所在站点名称 |
-
-**响应**
-
-| 字段名    | 数据类型 |  默认  | 说明         |
-| --------- | -------- | :----: | ------------ |
-| `success` | Boolean  | `true` | 提醒已读成功 |
-
-### 评论投票
-
-**POST** `/api/vote`
-
-**参数**
-
-| 字段名      | 数据类型 | 必需 | 说明                                                                                                        |
-| ----------- | -------- | :--: | ----------------------------------------------------------------------------------------------------------- |
-| `target_id` | Number   |  是  | 待投票评论 ID                                                                                               |
-| `type`      | String   |  否  | 待投票类型，前缀 `comment_`、`page_` 依次代表对评论投票、对页面投票，后缀 `_up`、`_down` 依次代表赞同、反对 |
-| `name`      | String   |  否  | 投票用户昵称                                                                                                |
-| `email`     | String   |  否  | 投票用户邮箱                                                                                                |
-| `site_name` | String   |  否  | 投票目标评论或页面所在站点名称                                                                              |
-
-**响应**
-
-| 字段名          | 数据类型 |  默认  | 说明                           |
-| --------------- | -------- | :----: | ------------------------------ |
-| `success`       | Boolean  | `true` | 评论投票成功                   |
-| `data.vote_num` | Number   |   -    | 目标评论或页面指定类型投票数据 |
-
-### Artalk 版本
-
-::: warning
-
-此接口较特殊，返回结果不包含 `success`、`msg`、`data` 字段，直接返回包含指定字段的 JSON。
-
-:::
-
-**GET/POST** `/api/version`
-
-**参数** 无
-
-**响应**
-
-| 字段名           | 数据类型 |   默认   | 说明                            |
-| ---------------- | -------- | :------: | ------------------------------- |
-| `app`            | String   | `artalk` | Artalk 后端程序名               |
-| `version`        | String   |    -     | Artalk 后端程序版本号           |
-| `commit_hash`    | String   |    -     | Artalk 后端程序 Git 提交哈希值  |
-| `fe_min_version` | String   |    -     | Artalk 后端程序所需前端最低版本 |
-
-## Captcha API
-
-### 验证码刷新
-
-**GET** `/api/captcha/refresh`
-
-**参数** 无
-
-**响应**
-
-| 字段名          | 数据类型 |  默认  | 说明                                 |
-| --------------- | -------- | :----: | ------------------------------------ |
-| `success`       | Boolean  | `true` | 验证码刷新成功                       |
-| `data.img_data` | String   |   -    | 根据 IP 获取的验证码图片 Base64 编码 |
-
-### 验证码检验
-
-**GET** `/api/captcha/check`
-
-**参数**
-
-| 字段名  | 数据类型 | 必需 | 说明   |
-| ------- | -------- | :--: | ------ |
-| `value` | String   |  是  | 验证码 |
-
-**响应**
-
-| 字段名          | 数据类型 |  默认  | 说明                                                     |
-| --------------- | -------- | :----: | -------------------------------------------------------- |
-| `success`       | Boolean  | `true` | 验证码检验成功                                           |
-| `data.img_data` | String   |   -    | 新的验证码图片 Base64 编码，仅验证码检验出错时存在此字段 |
-
-## Admin API
-
-### 评论编辑
-
-**POST** `/api/admin/comment-edit`
-
-**参数**
-
-| 字段名         | 数据类型 | 必需 | 说明                                              |
-| -------------- | -------- | :--: | ------------------------------------------------- |
-| `id`           | Number   |  是  | 待编辑评论 ID，**不可修改**                       |
-| `site_name`    | String   |  否  | 待编辑评论所在站点名称，**不可修改**              |
-| `content`      | String   |  否  | 待编辑评论正文                                    |
-| `page_key`     | String   |  否  | 待编辑评论所在页面唯一标识符                      |
-| `nick`         | String   |  否  | 待编辑评论所属用户昵称                            |
-| `email`        | String   |  否  | 待编辑评论所属用户邮箱                            |
-| `link`         | String   |  否  | 待编辑评论所属用户链接                            |
-| `rid`          | String   |  否  | 待编辑评论为回复评论时传入父评论 `ID`，否则为 `0` |
-| `ua`           | String   |  否  | 待编辑评论所属用户 User-Agent                     |
-| `ip`           | String   |  否  | 待编辑评论所属用户 IP                             |
-| `is_collapsed` | Boolean  |  否  | 待编辑评论是否折叠                                |
-| `is_pending`   | Boolean  |  否  | 待编辑评论是否待审                                |
-
-**响应**
-
-| 字段名         | 数据类型 |  默认  | 说明             |
-| -------------- | -------- | :----: | ---------------- |
-| `success`      | Boolean  | `true` | 评论编辑成功     |
-| `data.comment` | Object   |   -    | 编辑评论的新数据 |
-
-::: tip
-
-- `data.comment` 对象结构参考 [评论新增接口](#评论新增) `/api/add` 响应的 `data.comment`
-
-:::
-
-### 评论删除
-
-::: danger
-
-此接口不推荐外部调用。
-
-调用此接口前请务必核实评论 ID，一旦调用成功将删除该评论下所有相关数据。
-
-:::
-
-**POST** `/api/admin/comment-del`
-
-**参数**
-
-| 字段名      | 数据类型 | 必需 | 说明                   |
-| ----------- | -------- | :--: | ---------------------- |
-| `id`        | Number   |  是  | 待删除评论 ID          |
-| `site_name` | String   |  是  | 待删除评论所在站点名称 |
-
-**响应**
-
-| 字段名    | 数据类型 |  默认  | 说明         |
-| --------- | -------- | :----: | ------------ |
-| `success` | Boolean  | `true` | 评论删除成功 |
-
-### 页面获取
-
-**POST** `/api/admin/page-get`
-
-**参数**
-
-| 字段名      | 数据类型 | 必需 | 说明                   |
-| ----------- | -------- | :--: | ---------------------- |
-| `site_name` | String   |  是  | 待获取页面目标站点名称 |
-
-**响应**
-
-| 字段名       | 数据类型 |  默认  | 说明               |
-| ------------ | -------- | :----: | ------------------ |
-| `success`    | Boolean  | `true` | 页面获取成功       |
-| `data.pages` | Array    |   -    | 目标站点的页面数据 |
-| `data.sites` | Array    |   -    | 所有站点数据       |
-
-::: tip
-
-- `data.pages` 数组中元素结构参考 [评论获取接口](#评论获取) `/api/get` 响应的 `data.page`
-- `data.sites` 数组中元素结构参考 [站点编辑接口](#站点编辑) `/api/admin/site-edit` 响应的 `data.site`
-
-:::
-
-### 页面编辑
-
-**POST** `/api/admin/page-edit`
-
-**参数**
-
-| 字段名       | 数据类型 | 必需 | 说明                                 |
-| ------------ | -------- | :--: | ------------------------------------ |
-| `id`         | Number   |  是  | 待编辑页面 ID，**不可修改**          |
-| `site_name`  | String   |  否  | 待编辑页面所在站点名称，**不可修改** |
-| `key`        | String   |  否  | 待编辑页面唯一标识符                 |
-| `title`      | String   |  否  | 待编辑页面标题                       |
-| `admin_only` | Boolean  |  否  | 待编辑页面是否仅管理员可评论         |
-
-**响应**
-
-| 字段名      | 数据类型 |  默认  | 说明             |
-| ----------- | -------- | :----: | ---------------- |
-| `success`   | Boolean  | `true` | 页面编辑成功     |
-| `data.page` | Object   |   -    | 编辑页面的新数据 |
-
-::: tip
-
-- `data.page` 对象结构参考 [评论获取接口](#评论获取) `/api/get` 响应的 `data.page`
-
-:::
-
-### 页面删除
-
-::: danger
-
-此接口不推荐外部调用。
-
-调用此接口前请务必核实页面 ID，一旦调用成功将删除该页面下所有相关数据。
-
-:::
-
-**POST** `/api/admin/page-del`
-
-**参数**
-
-| 字段名      | 数据类型 | 必需 | 说明                   |
-| ----------- | -------- | :--: | ---------------------- |
-| `key`       | String   |  是  | 待删除页面唯一标识符   |
-| `site_name` | String   |  是  | 待删除页面所在站点名称 |
-
-**响应**
-
-| 字段名    | 数据类型 |  默认  | 说明         |
-| --------- | -------- | :----: | ------------ |
-| `success` | Boolean  | `true` | 页面删除成功 |
-
-### 页面更新
-
-**POST** `/api/admin/page-fetch`
-
-**参数**
-
-| 字段名 | 数据类型 | 必需 | 说明          |
-| ------ | -------- | :--: | ------------- |
-| `id`   | Number   |  是  | 待更新页面 ID |
-
-**响应**
-
-| 字段名      | 数据类型 |  默认  | 说明             |
-| ----------- | -------- | :----: | ---------------- |
-| `success`   | Boolean  | `true` | 页面更新成功     |
-| `data.page` | Object   |   -    | 更新页面的新数据 |
-
-::: tip
-
-- `data.page` 对象结构参考 [评论获取接口](#评论获取) `/api/get` 响应的 `data.page`
-
-:::
-
-### 站点获取
-
-**POST** `/api/admin/site-get`
-
-**参数** 无
-
-**响应**
-
-| 字段名       | 数据类型 |  默认  | 说明         |
-| ------------ | -------- | :----: | ------------ |
-| `success`    | Boolean  | `true` | 站点获取成功 |
-| `data.sites` | Array    |   -    | 所有站点数据 |
-
-::: tip
-
-- `data.sites` 数组中元素结构参考 [站点编辑接口](#站点编辑) `/api/admin/site-edit` 响应的 `data.site`
-
-:::
-
-### 站点新增
-
-**POST** `/api/admin/site-add`
-
-**参数**
-
-| 字段名 | 数据类型 | 必需 | 说明                                              |
-| ------ | -------- | :--: | ------------------------------------------------- |
-| `name` | String   |  是  | 待新增站点名称                                    |
-| `urls` | String   |  是  | 待新增站点链接，如有多个需以英文半角符号 `,` 分割 |
-
-**响应**
-
-| 字段名                | 数据类型 |  默认  | 说明                                            |
-| --------------------- | -------- | :----: | ----------------------------------------------- |
-| `success`             | Boolean  | `true` | 站点新增成功                                    |
-| `data.site`           | Object   |   -    | 新增站点的数据                                  |
-| `data.site.id`        | Number   |   -    | 站点 ID                                         |
-| `data.site.name`      | String   |   -    | 站点名称                                        |
-| `data.site.urls`      | Array    |   -    | 站点链接数组，元素为单个站点链接字符串          |
-| `data.site.urls_raw`  | String   |   -    | 站点链接数组合并字符串，以英文半角符号 `,` 分割 |
-| `data.site.first_url` | String   |   -    | 站点第一链接                                    |
-
-### 站点编辑
-
-**POST** `/api/admin/site-edit`
-
-**参数**
-
-| 字段名 | 数据类型 | 必需 | 说明             |
-| ------ | -------- | :--: | ---------------- |
-| `id`   | Number   |  是  | 待编辑站点 ID    |
-| `name` | String   |  是  | 待编辑站点新名称 |
-| `urls` | String   |  是  | 待编辑站点新链接 |
-
-**响应**
-
-| 字段名                | 数据类型 |  默认  | 说明                                            |
-| --------------------- | -------- | :----: | ----------------------------------------------- |
-| `success`             | Boolean  | `true` | 站点编辑成功                                    |
-| `data.site`           | Object   |   -    | 编辑站点的新数据                                |
-| `data.site.id`        | Number   |   -    | 站点 ID                                         |
-| `data.site.name`      | String   |   -    | 站点名称                                        |
-| `data.site.urls`      | Array    |   -    | 站点链接数组，元素为单个站点链接字符串          |
-| `data.site.urls_raw`  | String   |   -    | 站点链接数组合并字符串，以英文半角符号 `,` 分割 |
-| `data.site.first_url` | String   |   -    | 站点第一链接                                    |
-
-### 站点删除
-
-::: danger
-
-此接口不推荐外部调用。
-
-调用此接口前请务必核实站点 ID，一旦调用成功将删除该站点下所有相关数据。
-
-:::
-
-**POST** `/api/admin/site-del`
-
-**参数**
-
-| 字段名        | 数据类型 | 必需 | 说明                                                                |
-| ------------- | -------- | :--: | ------------------------------------------------------------------- |
-| `id`          | Number   |  是  | 待删除站点 ID                                                       |
-| `del_content` | Boolean  |  否  | 是否删除站点所有数据，为 `false` 时仅删除站点配置而保留站点评论数据 |
-
-**响应**
-
-| 字段名    | 数据类型 |  默认  | 说明         |
-| --------- | -------- | :----: | ------------ |
-| `success` | Boolean  | `true` | 站点删除成功 |
-
-### 设置获取
-
-**POST** `/api/admin/setting-get`
-
-**参数**
-
-| 字段名 | 数据类型 | 必需 | 说明           |
-| ------ | -------- | :--: | -------------- |
-| `id`   | Number   |  是  | 管理员用户 ID  |
-| `name` | String   |  否  | 管理员用户昵称 |
-| `url`  | String   |  否  | 管理员用户链接 |
-
-**响应**
-
-| 字段名    | 数据类型 |  默认  | 说明         |
-| --------- | -------- | :----: | ------------ |
-| `success` | Boolean  | `true` | 设置获取成功 |
-
-### 设置保存
-
-**POST** `/api/admin/setting-save`
-
-**参数**
-
-| 字段名 | 数据类型 | 必需 | 说明           |
-| ------ | -------- | :--: | -------------- |
-| `id`   | Number   |  是  | 管理员用户 ID  |
-| `name` | String   |  否  | 管理员用户昵称 |
-| `url`  | String   |  否  | 管理员用户链接 |
-
-**响应**
-
-| 字段名    | 数据类型 |  默认  | 说明         |
-| --------- | -------- | :----: | ------------ |
-| `success` | Boolean  | `true` | 设置保存成功 |
-
-### 邮件发送
-
-::: warning
-
-页面收到评论、评论收到回复等满足需要发送邮件提醒条件时，后端将自动向目标地址发送邮件提醒，不需手动处理邮件发送。请勿滥用此接口。
-
-:::
-
-**POST** `/api/admin/send-mail`
-
-**参数**
-
-| 字段名    | 数据类型 | 必需 | 说明       |
-| --------- | -------- | :--: | ---------- |
-| `subject` | String   |  是  | 邮件主题   |
-| `body`    | String   |  是  | 邮件正文   |
-| `to_addr` | String   |  是  | 邮件收件人 |
-
-**响应**
-
-| 字段名    | 数据类型 |  默认  | 说明         |
-| --------- | -------- | :----: | ------------ |
-| `success` | Boolean  | `true` | 邮件发送成功 |
-
-### Artrans 接口
-
-::: warning
-
-此接口暂不稳定，请避免使用！
-
-:::
-
-**POST** `/api/admin/artransfer`
-
-**参数**
-
-| 字段名    | 数据类型 | 必需 | 说明         |
-| --------- | -------- | :--: | ------------ |
-| `type`    | String   |  是  | 导入数据类型 |
-| `payload` | String   |  否  | 导入数据     |
-
-**响应** 无

docs/docs/develop/compatibility.md

@@ -1,18 +0,0 @@
-# 兼容性
-
-## 浏览器兼容性
-
-Artalk 客户端生产环境代码的构建通过 esbuild 执行，构建目标为 `es2015`。但请注意，构建仅会处理语法转义遵循 `es2015` 标准，不会处理 API 的兼容性（不包含任何 polyfill）。
-
-如果你的项目需要支持较旧的浏览器和设备，请考虑在捆绑应用程序中包含全局 polyfill。我们推荐使用 [Polyfill.io](https://polyfill.io/) 服务，它会根据用户的 User-Agent 动态返回所需的 polyfill。另外，你也可以使用 [core-js](https://github.com/zloirock/core-js) 或 [Babel](https://babeljs.io/) 来手动添加 polyfill。
-
-以下是 Artalk 使用的现代功能的列表：
-
-- [All ECMAScript 2015 (ES6) features](https://compat-table.github.io/compat-table/es6/)
-- [Fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)
-- [AbortController](https://developer.mozilla.org/en-US/docs/Web/API/AbortController)
-- [Intersection Observer](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API)
-
-## 服务器兼容性
-
-Artalk 服务端程序基于 Golang 开发，支持 Linux、Windows 和 macOS 等操作系统。当前 Artalk 的 Golang 版本可通过 [go.mod](https://github.com/ArtalkJS/Artalk/blob/master/go.mod#L3) 查看。关于 Golang 的最低操作系统要求，可参考 [Go Wiki](https://go.dev/wiki/MinimumRequirements)。

docs/docs/develop/contributing.md

@@ -1,298 +0,0 @@
-# 开发者贡献指南
-
-本指南帮助开发者了解如何在 Artalk 项目中贡献代码、文档、测试和反馈。我们欢迎所有形式的贡献，无论是大型功能开发、小型修复、文档改进还是测试。我们相信每一个贡献都是推动项目前进的重要一环。
-
-本指南包含多语言版本：[English](https://github.com/ArtalkJS/Artalk/blob/master/CONTRIBUTING.md) • [简体中文](https://artalk.js.org/develop/contributing.html)
-
-## 克隆仓库
-
-克隆仓库：
-
-```sh
-git clone https://github.com/ArtalkJS/Artalk.git
-```
-
-建议您先 fork 仓库，然后克隆 fork 后的仓库。
-
-导航到目录：
-
-```sh
-cd Artalk
-```
-
-## 开发环境
-
-为了开发 Artalk 的前端和后端，请安装以下工具：
-
-- [Node.js](https://nodejs.org/en/) (>= 20.17.0)
-- [PNPM](https://pnpm.io/) (>= 9.9.0)
-- [Go](https://golang.org/) (>= 1.22)
-- [Docker](https://www.docker.com/) (>= 20.10.0)（可选）
-- [Docker Compose](https://docs.docker.com/compose/) (>= 1.29.0)（可选）
-
-## 开发工作流程概述
-
-开发工作流程包括以下步骤：
-
-1. **搭建完整的开发实例**：
-
-   - 导航到 Artalk 仓库目录。
-   - 执行 `make dev` 在端口 `23366` 上运行后端。
-   - 执行 `pnpm dev` 在端口 `5173` 上运行前端。
-   - 可选地，执行 `pnpm dev:sidebar` 在端口 `23367` 上运行侧边栏前端。
-
-2. **访问前端进行开发**：
-
-   - 打开浏览器，访问 `http://localhost:5173` 进行开发和测试。
-
-3. **测试**：
-
-   - 使用 `make test` 运行后端单元测试。
-   - 使用 `pnpm test` 运行 UI 单元测试。
-   - 使用 `make test-frontend-e2e` 运行 UI 端到端测试。
-
-4. **构建前端代码**：
-
-   - 当您对前端代码进行更改后，使用 `pnpm build:all` 构建完整的前端程序。
-   - JavaScript 和 CSS 代码将在 `ui/artalk/dist` 目录中找到。
-   - 前端代码由 GitHub Actions 自动部署到 NPM。
-
-5. **构建后端代码**：
-
-   - 当您对后端代码进行更改后，注意后端程序会嵌入前端代码。
-   - 在构建后端之前，运行 `make build-frontend`（它运行 `scripts/build-frontend.sh`）。这将把嵌入的前端主程序和侧边栏前端程序放入 `/public` 目录。
-   - 然后，使用 `make build` 构建后端程序。
-
-更多探索：
-
-- **开发 Artalk 插件或主题**：
-  请参考 [Artalk 插件开发指南](https://artalk.js.org/develop/plugin.html)。
-
-- **Makefile**：
-  您可以探索 `Makefile` 中的过程和命令。
-
-- **GitHub 上的自动化 CI**：
-  GitHub 上的自动化 CI 流水线位于 `.github/workflows` 目录中，负责构建前端、后端和 Docker 镜像，发布 Docker 镜像到 Docker Hub，处理 npm 包发布，并创建 GitHub Releases，同时测试前端和后端。
-
-以下部分提供了更详细的开发工作流程信息。
-
-## 项目结构
-
-Artalk 是一个 monorepo 项目，这意味着所有源代码都在一个仓库中。尽管如此，前端和后端保持分离。前端部分位于 `./ui` 目录中。
-
-### 目录概览
-
-- `bin/`：编译的二进制文件。（此目录被 git 忽略）
-- `cmd/`：命令行工具的源代码。
-- `conf/`：示例配置文件。
-- `data/`：本地数据。（此目录被 git 忽略）
-- `docs/`：文档站点的源代码。
-- `i18n/`：翻译文件。
-- `local/`：本地文件。（此目录被 git 忽略）
-- `internal/`：内部包的 Go 源代码。
-- `public/`：静态文件。构建的前端文件将被复制到这里。
-- `scripts/`：开发和构建的脚本。
-- `server/`：后端的 Go 源代码。
-- `ui/`：前端的 UI 源代码。
-- `.github/`：GitHub Actions 工作流。
-- `.vscode/`：VSCode 设置。
-
-## 后端开发
-
-### 运行后端
-
-1. **创建配置文件**：
-
-   - 将 `./conf/artalk.example.yml` 复制到根目录。
-   - 重命名为 `artalk.yml`。
-   - 根据需要修改文件。
-
-2. **启动后端程序**：
-
-   - 运行 `make dev` 启动后端，端口为 `23366`。
-   - 通过 `http://localhost:23366` 访问。
-   - 建议保留默认端口进行测试。
-   - （替代）使用 `ARGS="version" make dev` 传递启动参数（默认是 `ARGS="server"`）。
-
-`make dev` 命令会带有调试符号构建后端，这方便使用 GDB 进行调试。
-
-如果您使用 VSCode，可以使用 `F5` 键（或运行按钮）直接启动调试后端程序。
-
-### 构建后端
-
-1. **获取最新的 Git 标签**：
-   执行 `git fetch --tags` 获取最新的 Git 标签信息。此标签将用作后端应用程序的版本号。或者，通过环境变量指定：`VERSION="v1.0.0"` 和 `COMMIT_HASH="66128e"`。
-
-2. **构建前端**：
-   运行 `make build-frontend` 构建前端，因为后端应用程序会嵌入前端代码。
-
-3. **构建后端**：
-   执行 `make build` 构建后端程序。
-
-构建的二进制文件将位于 `./bin` 目录中。
-
-## 前端开发（UI）
-
-### 运行前端
-
-1. **安装依赖**：
-   运行 `pnpm install` 安装所有必要的依赖。
-
-2. **启动开发服务器**：
-   执行 `pnpm dev --port 5173` 启动前端开发服务器。
-
-3. **访问前端**：
-   前端应用程序默认将在端口 `5173` 上运行。在浏览器中访问 `http://localhost:5173`。
-
-4. **侧边栏开发**：
-   要运行侧边栏部分的前端，请使用 `pnpm dev:sidebar`。
-
-端口 `5173` 和 `23367` 用于前端开发和测试。这些端口被包括在后端程序的 `ATK_TRUSTED_DOMAINS` 配置中。
-
-### 构建前端
-
-要构建前端，请运行以下命令：
-
-```sh
-make build-frontend
-```
-
-编译的 JavaScript 和 CSS 文件将位于 `/public` 目录中，嵌入到后端程序中。
-
-更多详细信息，请参考 `scripts/build-frontend.sh` 脚本。
-
-## Docker 开发
-
-### 构建 Docker 镜像
-
-要构建 Docker 镜像，请运行以下命令：
-
-```sh
-docker build -t artalk:TAG .
-```
-
-将 `TAG` 替换为所需的标签名（例如 `latest`）。
-
-### 跳过前端构建
-
-如果您已经在 Docker 容器外部构建了前端，可以跳过容器内的前端构建过程以加快构建速度。使用以下命令：
-
-```sh
-docker build --build-arg SKIP_FRONTEND_BUILD=true -t artalk:latest .
-```
-
-更多详细信息，请参考 `Dockerfile`。
-
-## 测试
-
-### 测试后端
-
-要测试后端 Go 程序，可以使用以下命令：
-
-- **单元测试**：
-  运行 `make test` 执行单元测试。结果将输出在终端。
-
-- **测试覆盖率**：
-  运行 `make test-coverage` 检查代码测试覆盖率。
-
-- **HTML 覆盖率报告**：
-  运行 `make test-coverage-html` 生成并浏览 HTML 格式的测试覆盖率报告。
-
-- **运行特定测试**：
-  要运行特定测试，请使用带有环境变量的命令：
-  ```sh
-  TEST_PATHS="./server/..." make test
-  ```
-
-### 测试前端
-
-前端测试包括单元测试和端到端（E2E）测试。
-
-- **单元测试**：
-  前端的单元测试使用 Vitest 进行。运行 `pnpm test` 开始单元测试。
-
-- **端到端测试**：
-  E2E 测试使用 Playwright 进行。要启动 E2E 测试，运行：
-  ```sh
-  make test-frontend-e2e
-  ```
-
-### 持续集成测试
-
-前端和后端的测试都是自动化的，并将在 Git pull 请求和构建过程中使用 CircleCI 或 GitHub Actions 执行。
-
-## 配置
-
-模板配置文件位于 `/conf` 目录中，模板以多种语言注释，命名格式为 `artalk.example.[lang].yml`（例如，`artalk.example.zh-CN.yml`）。Artalk 将解析这些模板配置文件以生成设置界面、环境变量名称和文档。为了提高性能，程序运行期间将缓存部分数据以消除解析时间。
-
-在 `internal/config/config.go` 文件中，有一个名为 `Config` 的结构体定义，该结构体用于将 yml 文件解析为 Go 结构体。该结构体包含更精确的类型定义。如果需要添加、修改或删除配置项，必须同时修改 `/conf` 目录中的配置文件模板和 `Config` 结构体。
-
-当您修改配置文件后，请运行以下命令以更新配置数据缓存：
-
-```sh
-make update-conf
-```
-
-要更新环境变量文档，可以运行以下命令：
-
-```sh
-make update-conf-docs
-```
-
-## 文档
-
-文档由三个部分组成，每个部分与特定包相关：**指南文档**、**着陆页**和 **Swagger API 文档**。下面是每个包的相关命令及其输出的总结。
-
-### 指南文档 (`docs`)
-
-- **目录**：`docs/docs/guide`
-- **开发命令**：`pnpm -F docs dev:docs`
-- **构建命令**：`pnpm -F docs build:docs`
-- **输出目录**：`docs/docs/.vitepress/dist`
-
-### 着陆页 (`docs-landing`)
-
-- **目录**：`docs/landing`
-- **开发命令**：`pnpm -F docs-landing dev:landing`
-- **构建命令**：`pnpm -F docs-landing build:landing`
-- **输出目录**：`docs/landing/dist`
-
-### Swagger API 文档 (`docs-swagger`)
-
-- **目录**：`docs/swagger`
-- **构建命令**：`make update-swagger`
-- **输出目录**：`docs/swagger`
-
-Swagger 定义位于后端代码的 `/server` 目录中。修改 Swagger 定义后，运行构建命令将更新 Swagger 文档并在 `/ui/artalk/src/api/v2.ts` 生成 HTTP 客户端代码。
-
-### 综合构建
-
-- **构建所有包的命令**：`pnpm build:docs`
-- **综合输出目录**：`docs/docs/.vitepress/dist`
-
-此命令构建并组合所有三个包到单个目录中，准备发布。
-
-### 环境变量文档
-
-- **文件**：`docs/docs/guide/env.md`
-- **更新命令**：`make update-conf-docs`
-
-此命令读取位于 `/conf` 的配置模板文件以更新环境变量文档。在修改配置模板文件后运行此命令。
-
-## 翻译 (i18n)
-
-如果您编写了新功能或进行了修复/重构，请使用以下命令通过解析源代码中的 `i18n.T` 函数调用来增量生成翻译文件：
-
-```sh
-make update-i18n
-```
-
-如果您不是程序员，但希望帮助改进翻译，可以直接编辑 `/i18n` 目录中的翻译文件，然后提交 pull 请求。
-
-## 结尾
-
-感谢您耐心阅读本指南，并感谢您对 Artalk 的兴趣和支持。我们深知，一个开源项目的成功依赖于每一位开发者的贡献。无论是通过代码、文档、测试还是反馈，您的参与是推动项目持续进步的动力。我们诚挚邀请您加入我们，共同改进和增强 Artalk。
-
-通过合作，我们可以创建一个更加健壮和多功能的平台，造福整个社区。您的独特见解和专业知识是无价的，只有共同努力，我们才能实现显著的进步。无论您是经验丰富的开发者，还是刚刚起步的新手，我们的项目中总有您可以贡献的一席之地。
-
-如果您有任何问题或需要帮助，请随时在我们的 GitHub 页面上的 issue 部分提问：<https://github.com/ArtalkJS/Artalk/issues>。再次感谢您的支持，我们期待与您合作。

docs/docs/develop/event.md

@@ -1,50 +0,0 @@
-# Frontend Event
-
-## 基本事件
-
-| 事件名              | 描述                 |
-| ------------------- | -------------------- |
-| `created`           | 初始化后             |
-| `mounted`           | 数据加载后           |
-| `updated`           | 数据更新后           |
-| `unmounted`         | 销毁后               |
-| `list-fetch`        | 评论列表请求时       |
-| `list-fetched`      | 评论列表请求后       |
-| `list-load`         | 评论装载前           |
-| `list-loaded`       | 评论装载后           |
-| `list-failed`       | 评论加载错误时       |
-| `list-goto-first`   | 评论列表归位时       |
-| `list-reach-bottom` | 评论列表滚动到底部时 |
-| `comment-inserted`  | 评论插入后           |
-| `comment-updated`   | 评论更新后           |
-| `comment-deleted`   | 评论删除后           |
-| `comment-rendered`  | 评论节点渲染后       |
-| `notifies-updated`  | 未读消息变更时       |
-| `list-goto`         | 评论跳转时           |
-| `page-loaded`       | 页面数据更新后       |
-| `editor-submit`     | 编辑器提交时         |
-| `editor-submitted`  | 编辑器提交后         |
-| `user-changed`      | 本地用户数据变更时   |
-| `sidebar-show`      | 侧边栏显示           |
-| `sidebar-hide`      | 侧边栏隐藏           |
-
-事件声明代码：[@ArtalkJS/Artalk - src/types/event.ts](https://github.com/ArtalkJS/Artalk/blob/master/ui/artalk/src/types/event.ts)
-
-## 添加事件监听
-
-```js
-artalk.on('list-loaded', () => {
-  alert('评论已加载完毕')
-})
-```
-
-## 解除事件监听
-
-```js
-let foo = function () {
-  /* do something */
-}
-
-artalk.on('list-loaded', foo)
-artalk.off('list-loaded', foo)
-```

docs/docs/develop/import-framework.md

@@ -1,227 +0,0 @@
-# 置入框架
-
-## 安装 Artalk
-
-通过包管理工具引入 Artalk，推荐使用 [pnpm](https://pnpm.io/zh/)
-
-```bash
-pnpm add artalk
-```
-
-## Vue
-
-::: code-group
-
-```vue [Vue 3]
-<script lang="ts" setup>
-import Artalk from 'artalk'
-import { onMounted, onBeforeUnmount, ref } from 'vue'
-
-import 'artalk/dist/Artalk.css'
-
-const el = ref<HTMLElement>()
-
-let artalk: Artalk
-
-onMounted(() => {
-  artalk = Artalk.init({
-    el: el.value,
-    pageKey: location.pathname,
-    pageTitle: `${document.title}`,
-    server: 'http://localhost:8080',
-    site: 'Artalk 的博客',
-    // ...
-  })
-})
-
-onBeforeUnmount(() => {
-  artalk.destroy()
-})
-</script>
-
-<template>
-  <view ref="el"></view>
-</template>
-```
-
-```vue [Vue 3 + Vue Router]
-<script lang="ts" setup>
-import Artalk from 'artalk'
-import { onMounted, onBeforeUnmount, ref, watch, nextTick } from 'vue'
-import { useRouter } from 'vue-router'
-
-import 'artalk/dist/Artalk.css'
-
-const el = ref<HTMLElement>()
-const router = useRouter()
-
-let artalk: Artalk
-
-onMounted(() => {
-  artalk = Artalk.init({
-    el: el.value,
-    pageKey: router.route.path,
-    pageTitle: document.title,
-    server: 'http://localhost:8080',
-    site: 'Artalk 的博客',
-    // ...
-  })
-})
-
-watch(
-  () => router.route.path,
-  (path) => {
-    nextTick(() => {
-      artalk.update({
-        pageKey: path,
-        pageTitle: document.title,
-      })
-      artalk.reload()
-    })
-  }
-)
-
-onBeforeUnmount(() => {
-  artalk.destroy()
-})
-</script>
-
-<template>
-  <view ref="el"></view>
-</template>
-```
-
-:::
-
-## React
-
-::: code-group
-
-```tsx [React Hooks]
-import React, { useEffect, useRef } from 'react'
-import { useLocation } from 'react-router-dom'
-import 'artalk/dist/Artalk.css'
-import Artalk from 'artalk'
-
-const ArtalkComment = () => {
-  const container = useRef<HTMLDivElement>(null)
-  const location = useLocation()
-  const artalk = useRef<Artalk>()
-
-  useEffect(() => {
-    artalk.current = Artalk.init({
-      el: container.current!,
-      pageKey: location.pathname,
-      pageTitle: document.title,
-      server: 'http://localhost:8080',
-      site: 'Artalk 的博客',
-      // ...
-    })
-
-    return () => {
-      artalk.current?.destroy()
-    }
-  }, [container, location.pathname])
-
-  return <div ref={container}></div>
-}
-
-export default ArtalkComment
-```
-
-
-
-```jsx [React Class]
-import React, { createRef } from 'react'
-import 'artalk/dist/Artalk.css'
-import Artalk from 'artalk'
-
-export default class Artalk extends React.Component {
-  el = createRef()
-  artalk = null
-
-  componentDidMount() {
-    this.artalk = Artalk.init({
-      el: this.el.current,
-      pageKey: location.pathname,
-      pageTitle: document.title,
-      server: 'http://localhost:8080',
-      site: 'Artalk 的博客',
-      // ...
-    })
-  }
-
-  componentWillUnmount() {
-    this.artalk?.destroy()
-  }
-
-  render() {
-    return <div ref={this.el} />
-  }
-}
-```
-
-:::
-
-## SolidJS
-
-```tsx
-import { onCleanup, onMount } from 'solid-js'
-import Artalk from 'artalk'
-import 'artalk/dist/Artalk.css'
-
-const ArtalkComment = () => {
-  let el: HTMLDivElement
-  let artalk: Artalk
-
-  onMount(() => {
-    artalk = Artalk.init({
-      el: el,
-      pageKey: location.pathname,
-      pageTitle: document.title,
-      server: 'http://localhost:8080',
-      site: 'Artalk 的博客',
-      // ...
-    })
-
-    onCleanup(() => {
-      artalk.destroy()
-    })
-  })
-
-  return <div ref={el} />
-}
-```
-
-## Svelte
-
-```html
-<script>
-import Artalk from 'artalk'
-import { onMount, onDestroy } from 'svelte'
-
-import 'artalk/dist/Artalk.css'
-
-let el
-let artalk
-
-onMount(() => {
-  artalk = Artalk.init({
-    el: el,
-    pageKey: location.pathname,
-    pageTitle: document.title,
-    server: 'http://localhost:8080',
-    site: 'Artalk 的博客',
-    // ...
-  })
-
-  onDestroy(() => {
-    if (artalk) {
-      artalk.destroy()
-    }
-  })
-})
-</script>
-
-<div bind:this="{el}"></div>
-```

docs/docs/develop/index.md

@@ -1,39 +0,0 @@
-# 开发文档
-
-欢迎来到 Artalk 官方开发文档，这里提供了构建 Artalk 插件和主题的指南。如果你需要搭建 Artalk 的开发环境，可以阅读 [开发者贡献指南](./contributing.md)。
-
-感谢对 Artalk 的关注和支持。我们深知开源项目的成功离不开每一位开发者的贡献，无论是代码、文档、测试还是意见反馈，您的参与都是推动项目不断前进的动力。诚挚地邀请您加入我们，共同完善和提升 Artalk。
-
-## 索引
-
-- [开发者贡献指南](./contributing.md) ⭐️
-
-**前端界面**
-
-- [置入博客](./import-blog.md)
-- [置入框架](./import-framework.md)
-- [前端 API 文档](./fe-api.md)
-- [前端 Event](./event.md)
-- [前端配置](../guide/frontend/config.md)
-
-**插件开发**
-
-- [插件开发](./plugin.md)
-- [插件开发 Vite 集成](https://github.com/ArtalkJS/Artalk/blob/master/ui/plugin-kit/README.md)
-
-**后端程序**
-
-- <a href="/http-api.html" target="_blank">HTTP API 文档</a>
-- [环境变量](../guide/env.md)
-- [配置文件](../guide/backend/config.md)
-
-**其他内容**
-
-- [兼容性](../develop/compatibility.md)
-- [更新日志](https://github.com/ArtalkJS/Artalk/blob/master/CHANGELOG.md)
-- [i18n 多语言贡献指南](../guide/frontend/i18n.md#贡献翻译)
-- [贡献者契约行为准则](https://github.com/ArtalkJS/Artalk/blob/master/CODE_OF_CONDUCT.md)
-
-::: tip
-Artalk 正处于积极维护阶段，请注意 API 版本兼容性。升级可能有突破性变更参考 [更新日志](https://github.com/ArtalkJS/Artalk/blob/master/CHANGELOG.md)。
-:::

docs/docs/develop/plugin.md

@@ -1,130 +0,0 @@
-# 插件开发
-
-## 使用 Vite 开发
-
-我们提供了 Vite 的集成插件，使用 Vite 开发能够开箱即用地构建 Artalk 插件，简化 Vite 配置。
-
-参考文档：[@artalk/plugin-kit](https://github.com/ArtalkJS/Artalk/blob/master/ui/plugin-kit/README.md)。
-
-同时，我们提供了一个模版代码仓库，你可以直接 fork 来开发插件：[artalk-plugin-sample](https://github.com/ArtalkJS/artalk-plugin-sample)。
-
-通过 Vite 结合前端生态，你可以任选你喜欢的技术栈，如 Vue、React、Svelte、SolidJS 等框架开发 Artalk 插件。
-
-## `Artalk.use`
-
-使用 `Artalk.use` 来扩展 Artalk。
-
-```js
-import Artalk from 'artalk'
-
-Artalk.use((ctx) => {
-  ctx.on('list-loaded', () => {
-    console.log('评论列表加载完毕')
-    ctx.getCommentNodes().forEach((node) => {
-      node.getEl().style.background = 'red'
-    })
-  })
-})
-
-Artalk.use((ctx) => {
-  let el = null
-
-  ctx.on('mounted', () => {
-    el = document.createElement('div')
-    document.body.appendChild(el)
-    console.log('Artalk 实例被挂载')
-  })
-
-  ctx.on('unmounted', () => {
-    el.remove()
-    console.log('Artalk 实例被销毁')
-  })
-})
-
-const artalk = Artalk.init({ ... })
-```
-
-请注意：
-
-- `Artalk.use` 必须在 `Artalk.init` 之前调用才生效。
-- 请勿依赖插件的加载顺序，请监听事件来执行插件逻辑。
-- 当所有的插件加载完毕后，会触发 `created` 事件。
-- 当插件和配置加载完毕后，会触发 `mounted` 事件。
-- 当 Artalk 实例被销毁时，会触发 `unmounted` 事件。
-- 当配置发生变化时，会触发 `updated` 事件。
-
-在 use 函数中，你可以通过 `ctx` 来访问 Artalk 的 Context 对象。
-
-### 插件可配置选项
-
-在 TypeScript 中，你可以通过 `ArtalkPlugin<T>` 来定义一个带选项的插件类型。
-
-```ts
-export interface DemoPluginOptions {
-  foo?: string
-}
-
-export const ArtalkDemoPlugin: ArtalkPlugin<DemoPluginOptions> = (ctx, options = {}) => {
-  console.log(options.foo)
-}
-```
-
-在执行 `Artalk.use` 时，传入选项：
-
-```ts
-import { ArtalkDemoPlugin } from 'artalk-plugin-demo'
-
-Artalk.use(ArtalkDemoPlugin, { foo: 'bar' })
-```
-
-## ContextAPI
-
-Context 对象包含了 Artalk 的上下文信息。
-
-| 成员                  | 说明                 |
-| --------------------- | -------------------- |
-| `ctx.getEl`           | 获取容器元素         |
-| `ctx.getConf`         | 获取配置             |
-| `ctx.updateConf`      | 更新配置             |
-| `ctx.watchConf`       | 监听配置             |
-| `ctx.setDarkMode`     | 设置夜间模式         |
-| `ctx.getApi`          | 获取 API 客户端对象  |
-| --                    | --                   |
-| `ctx.fetch`           | 获取评论数据         |
-| `ctx.reload`          | 重载评论列表         |
-| `ctx.getComments`     | 获取所有评论数据对象 |
-| `ctx.getCommentNodes` | 获取所有评论节点对象 |
-| --                    | --                   |
-| `ctx.on`              | 添加事件监听         |
-| `ctx.off`             | 解除事件监听         |
-| `ctx.trigger`         | 触发事件             |
-| --                    | --                   |
-| `ctx.get`             | 获取依赖             |
-| `ctx.inject`          | 注入依赖             |
-
-::: warning
-Context API 目前仍不稳定，开发可能会有变动，升级请关注 CHANGELOG。
-:::
-
-参考：[@artalk/src/types/context.ts](https://github.com/ArtalkJS/Artalk/blob/master/ui/artalk/src/types/context.ts)
-
-Artalk 包含完整的 TypeScript 类型定义，你可以通过编辑器的自动补全来查看 API。
-
-## 示例插件
-
-以下为 Artalk 官方维护的外置插件列表：
-
-| 插件                                                                                         | 说明           |
-| -------------------------------------------------------------------------------------------- | -------------- |
-| [artalk-plugin-sample](https://github.com/ArtalkJS/artalk-plugin-sample)                     | 示例插件       |
-| [@artalk/plugin-katex](https://github.com/ArtalkJS/Artalk/tree/master/ui/plugin-katex)       | LaTeX 公式插件 |
-| [@artalk/plugin-auth](https://github.com/ArtalkJS/Artalk/tree/master/ui/plugin-auth)         | Auth 插件 (SolidJS) |
-| [@artalk/plugin-lightbox](https://github.com/ArtalkJS/Artalk/tree/master/ui/plugin-lightbox) | 图片灯箱基础插件   |
-
-同时 Artalk 内部也有很多插件的实现，你可以参考源码来开发插件：
-
-[@ArtalkJS/Artalk - src/plugins](https://github.com/ArtalkJS/Artalk/tree/master/ui/artalk/src/plugins)
-
-## 后端插件开发
-
-【TODO】

docs/docs/develop/plugs.md

@@ -1,7 +0,0 @@
-# 插件开发
-
-本页面内容已移动至 <https://artalk.js.org/develop/plugin.html>。
-
-<script setup lang="ts">
-if (!import.meta.env.SSR) window.location = 'https://artalk.js.org/develop/plugin.html';
-</script>

docs/docs/guide/about.md

@@ -1,7 +0,0 @@
-# 🥬 关于我们
-
-## ~~开发团队有人想自我介绍一下~~
-
-[@qwqcode](https://github.com/qwqcode)：🥬 + 🦜
-
-The Artalk. Made with <span style="color: red;">♥️</span>.

docs/docs/guide/backend/build.md

@@ -1,7 +0,0 @@
-# 后端构建
-
-本页面内容已移动至 <https://artalk.js.org/develop/contributing.html>。
-
-<script setup lang="ts">
-if (!import.meta.env.SSR) window.location = 'https://artalk.js.org/develop/contributing.html';
-</script>

docs/docs/guide/backend/data.md

@@ -1,7 +0,0 @@
-# 数据
-
-本页面内容已移动至 <https://artalk.js.org/guide/transfer.html>。
-
-<script setup lang="ts">
-if (!import.meta.env.SSR) window.location = 'https://artalk.js.org/guide/transfer.html';
-</script>

docs/docs/guide/backend/fe-control.md

@@ -1,7 +0,0 @@
-# 如何配置界面
-
-本页面内容已移动至 <https://artalk.js.org/guide/frontend/config.html>。
-
-<script setup lang="ts">
-if (!import.meta.env.SSR) window.location = 'https://artalk.js.org/guide/frontend/config.html';
-</script>

docs/docs/guide/backend/img-upload.md

@@ -1,114 +0,0 @@
-# 图片上传
-
-Artalk 提供图片上传功能，支持限制图片大小、上传频率等，你还能结合 UpGit 将图片上传到图床。
-
-你可以在 [控制中心](/guide/frontend/sidebar.md#设置) 的设置界面修改此配置，也可以通过 [配置文件](/guide/backend/config.md#图片上传-img_upload) 或 [环境变量](/guide/env.md#图片上传) 进行配置。
-
-## 配置文件
-
-完整的 `img_upload` 配置如下：
-
-```yaml
-# 图片上传
-img_upload:
-  enabled: true # 总开关
-  path: ./data/artalk-img/ # 图片存放路径
-  max_size: 5 # 图片大小限制 (单位：MB)
-  public_path: null # 指定图片链接基础路径 (默认为 "/static/images/")
-  # 使用 upgit 将图片上传到 GitHub 或图床
-  upgit:
-    enabled: false # 启用 upgit
-    exec: upgit -c <upgit配置文件路径> -t /artalk-img
-    del_local: true # 上传后删除本地的图片
-```
-
-## 使用 Upgit 上传到图床
-
-[UpGit](https://github.com/pluveto/upgit) 支持将图片上传到 Github、Gitee、腾讯云 COS、七牛云、又拍云、SM.MS 等图床或代码仓库。
-
-首先，根据 [README.md](https://github.com/pluveto/upgit) 的说明，下载 UpGit 并完成你需要上传的目标图床的配置。
-
-然后，将 UpGit 加入系统的环境变量中，在 `~/.bashrc` 加入：
-
-```bash
-export PATH=$PATH:/path/to/upgit
-```
-
-（或者直接移入 `/usr/bin`）
-
-最后，在 Artalk 的 `img_upload.upgit` 字段填入 UpGit 启动参数：
-
-```yaml
-upgit:
-  enabled: true # 启用 upgit
-  exec: upgit -c <upgit配置文件路径> -t /artalk-img
-  del_local: true # 上传后删除本地的图片
-```
-
-::: warning 更新注意
-从 `v2.8.4` 版本开始，为了增强安全性，Artalk 不再允许指定 UpGit 的可执行文件路径，请将其加入系统的环境变量中。:)
-:::
-
-### Docker 挂载 UpGit
-
-如果你使用 Docker 部署 Artalk，可以将 UpGit 可执行文件挂载到容器中：
-
-```bash
-docker run -d --name artalk -v /path/to/upgit:/usr/bin/upgit -v /path/to/artalk:/app/data -p 8080:23366 artalk
-```
-
-## 上传频率限制
-
-频率限制跟随 `captcha` 验证码配置，当超出限制将弹出验证码。
-
-可参考：[后端 · 验证码](/guide/backend/captcha.md)
-
-## path
-
-`img_upload.path` 为上传的图片文件「本地存放目录」路径，该目录会被 Artalk 映射到可访问的：
-
-```
-http://<后端地址>/static/images/
-```
-
-## public_path
-
-`img.public_path` 为空的默认值为：`/static/images/`
-
-当该项为「相对路径」时，例如：`/static/images/` 前端上传图片得到的 HTML 标签将为：
-
-```html
-<img src="http://<后端地址>/static/images/1.png" />
-```
-
-注：这里的 `<后端地址>` 是前端 `conf.server` 配置。
-
-当该项为「完整 URL 路径」时，例如：`https://cdn.github.com/img/` 时，图片标签将为：
-
-```html
-<img src="https://cdn.github.com/img/1.png" />
-```
-
-提示：这个配置可以结合负载均衡等场景使用。
-
-## 在前端自定义上传 API
-
-前端提供了配置项 `imgUploader`，你可以自定义前端图片上传时请求的 API，例如：
-
-```js
-Artalk.init({
-  imgUploader: async (file) => {
-    const form = new FormData()
-    form.set('file', file)
-
-    const imgUrl = await fetch('https://api.example.org/upload', {
-      method: 'POST',
-      body: form,
-    })
-
-    return imgUrl
-  },
-})
-```
-
-参考：[前端配置文档](../frontend/config.md#imguploader)

docs/docs/guide/backend/install.md

@@ -1,7 +0,0 @@
-# 后端部署
-
-本页面内容已移动至 <https://artalk.js.org/guide/deploy.html>。
-
-<script setup lang="ts">
-if (!import.meta.env.SSR) window.location = 'https://artalk.js.org/guide/deploy.html';
-</script>

docs/docs/guide/backend/multi-site.md

@@ -1,88 +0,0 @@
-# 管理员 × 多站点
-
-Artalk 支持多站点，管理员可以创建多个站点，并对不同站点的评论、页面进行集中管理。
-
-## 创建管理员
-
-执行命令根据命令行提示快速创建管理员。
-
-```sh
-./artalk admin
-```
-
-如果使用 Docker 可以执行以下命令：
-
-```sh
-docker exec -it artalk artalk admin
-```
-
-之后可使用管理员账户登录控制中心，在用户管理页面的图形界面可创建更多账户，无需手动编辑配置文件。
-
-## 站点的创建和管理
-
-你可以在侧边栏「[控制中心](../frontend/sidebar.md#控制中心)」创建多个站点，管理站点和快速切换站点。
-
-## 管理员配置
-
-你可以设置多个管理员账户，当输入框输入匹配管理员用户名和邮箱时，将弹出密码验证提示框，
-
-并且只有管理员才能访问「[控制中心](../frontend/sidebar.md#控制中心)」，在前端对评论内容进行管理操作。
-
-（可选操作）通过配置文件添加管理员：
-
-```yaml
-admin_users:
-  - name: admin
-    email: admin@example.com
-    password: (bcrypt)$2y$10$ti4vZYIrxVN8rLcYXVgXCO.GJND0dyI49r7IoF3xqIx8bBRmIBZRm
-    badge_name: 管理员
-    badge_color: '#0083FF'
-  - name: admin2
-    email: admin2@example.com
-    password: (bcrypt)$2y$10$ti4vZYIrxVN8rLcYXVgXCO.GJND0dyI49r7IoF3xqIx8bBRmIBZRm
-    badge_name: 小管理员
-    badge_color: '#0083FF'
-```
-
-每项配置的解释：
-
-- **name** & **email**：用户名和邮箱，**不区分大小写**。
-- **password**：用户密码。
-
-  支持 bcrypt 和 md5 加密，例如填写：`"(md5)50c21190c6e4e5418c6a90d2b5031119"`。
-
-  **建议使用更安全的 bcrypt 加密算法**，在 Linux 环境下，你可以使用 [htpasswd 命令](https://httpd.apache.org/docs/2.4/programs/htpasswd.html) 来生成密文：
-
-  ```bash
-  unset HISTFILE # 临时禁用 history 防止密码在历史记录中出现
-  htpasswd -bnBC 10 "" "your_password" | tr -d ':'
-  ```
-
-  然后配置填写：`"(bcrypt)$2y$10$ti4vZYIrxVN8rLcY..."`，以 `(bcrypt)` 开头。
-
-  命令解释参考：[Compute bcrypt hash from command line](https://unix.stackexchange.com/questions/307994/compute-bcrypt-hash-from-command-line#answer-419855)
-
-- **badge_name**：用户显示的头衔徽标文字。
-- **badge_color**：用户显示的头衔徽标背景颜色。
-
-::: tip
-
-可以通过环境变量配置管理员账户，参考：[环境变量配置](/guide/env.md)
-
-:::
-
-### 控制管理员接收邮件通知
-
-当页面有新的评论时，默认配置是邮件会发送给全部管理员，但你可以配置 `receive_email` 强制禁用它。
-
-这对于设定了多个邮箱，但又不希望某些邮箱收到评论邮件的情况很有帮助。
-
-- **receive_email**：设置为 `false` 系统将不会发送邮件通知给该用户。
-
-  注：禁止后该管理员用户仍可以收到来自他人的 @AT 回复，只是当用户对页面进行评论时 (创建根评论时) 不发送邮件通知。
-
-```yaml
-admin_users:
-  - name: admin
-    receive_email: false # ← 强制不接收邮件
-```

docs/docs/guide/deploy.md

@@ -1,227 +0,0 @@
-# 📦 程序部署
-
-## Docker 部署
-
-推荐使用 Docker 部署，需预先安装 [Docker 引擎](https://docs.docker.com/engine/install/)，执行命令创建容器：
-
-```bash
-docker run -d \
-    --name artalk \
-    -p 8080:23366 \
-    -v $(pwd)/data:/data \
-    -e "TZ=Asia/Shanghai" \
-    -e "ATK_LOCALE=zh-CN" \
-    -e "ATK_SITE_DEFAULT=Artalk 的博客" \
-    -e "ATK_SITE_URL=https://example.com" \
-    artalk/artalk-go
-```
-
-执行命令创建管理员账户：
-
-```bash
-docker exec -it artalk artalk admin
-```
-
-浏览器输入 `http://artalk.example.com:8080` 进入 Artalk 后台登录界面。
-
-在网页中引入 Artalk 程序内嵌的的前端 JS 和 CSS 资源并初始化 Artalk：
-
-<!-- prettier-ignore-start -->
-
-```html
-<!-- CSS -->
-<link href="http://artalk.example.com:8080/dist/Artalk.css" rel="stylesheet" />
-
-<!-- JS -->
-<script src="http://artalk.example.com:8080/dist/Artalk.js"></script>
-
-<!-- Artalk -->
-<div id="Comments"></div>
-<script>
-Artalk.init({
-  el:        '#Comments',                // 绑定元素的 Selector
-  pageKey:   '/post/1',                  // 固定链接
-  pageTitle: '关于引入 Artalk 的这档子事',  // 页面标题 (留空自动获取)
-  server:    'http://artalk.example.com:8080',  // 后端地址
-  site:      'Artalk 的博客',             // 你的站点名
-})
-</script>
-```
-<!-- prettier-ignore-end -->
-
-评论框输入管理员用户名和邮箱，「控制台」按钮将出现在评论框右下角。
-
-在控制台，你可以根据喜好[配置评论系统](./backend/config.md)、[将评论迁移到 Artalk](./transfer.md)。
-
-🥳 你已成功完成 Artalk 部署！
-
-## 普通方式部署
-
-1. [GitHub Release](https://github.com/ArtalkJS/Artalk/releases) 下载程序压缩包
-2. 解压 `tar -zxvf artalk_版本号_系统_架构.tar.gz`
-3. 运行 `./artalk server`
-4. 配置
-
-   ```js
-   Artalk.init({ server: 'http://artalk.example.com:23366' })
-   ```
-
-进阶操作：
-
-- [守护进程 (Systemd, Supervisor)](./backend/daemon.md)
-- [反向代理 (Caddy, Nginx, Apache)](./backend/reverse-proxy.md)
-- [自编译 (通过最新代码构建)](../develop/contributing.md)
-
-## Compose 部署
-
-**compose.yaml**
-
-```yaml
-version: '3.8'
-services:
-  artalk:
-    container_name: artalk
-    image: artalk/artalk-go
-    restart: unless-stopped
-    ports:
-      - 8080:23366
-    volumes:
-      - ./data:/data
-    environment:
-      - TZ=Asia/Shanghai
-      - ATK_LOCALE=zh-CN
-      - ATK_SITE_DEFAULT=Artalk 的博客
-      - ATK_SITE_URL=https://your_domain
-```
-
-创建容器：
-
-```bash
-docker-compose up -d
-```
-
-::: details Compose 常用命令
-
-```bash
-docker-compose restart  # 重启容器
-docker-compose stop     # 暂停容器
-docker-compose down     # 删除容器
-docker-compose pull     # 更新镜像
-docker-compose exec artalk bash # 进入容器
-```
-
-:::
-
-参考文档：[Docker](./backend/docker.md) / [环境变量](./env.md)
-
-::: warning
-
-自 2024-06-06 开始，境内的 Docker Hub 镜像相继停止服务，可选择配置代理或自建镜像。
-
-详见：[Docker 镜像加速](https://gist.github.com/y0ngb1n/7e8f16af3242c7815e7ca2f0833d3ea6)。
-
-:::
-
-## Linux 发行版
-
-**Arch Linux (AUR)**：
-
-```bash
-paru -S artalk
-```
-
-**NixOS**：
-
-```bash
-nix-env -iA nixpkgs.artalk
-```
-
-**Termux**：
-
-```bash
-pkg install artalk
-```
-
-[![Packaging status](https://repology.org/badge/vertical-allrepos/artalk.svg)](https://repology.org/project/artalk/versions)
-
-## CDN 资源
-
-::: tip Artalk 最新版本
-
-当前 Artalk 前端最新版本号为： **:ArtalkVersion:**
-
-若需升级前端将 URL 中的版本号数字部分替换即可。
-:::
-
-Artalk 后端程序内嵌了前端 JS、CSS 文件，使用公共 CDN 资源请注意版本兼容性。
-
-**CDNJS**
-
-> <https://cdnjs.cloudflare.com/ajax/libs/artalk/:ArtalkVersion:/Artalk.js>
->
-> <https://cdnjs.cloudflare.com/ajax/libs/artalk/:ArtalkVersion:/Artalk.css>
-
-::: details 查看更多
-**SUSTech Mirrors (境内)**
-
-> <https://mirrors.sustech.edu.cn/cdnjs/ajax/libs/artalk/:ArtalkVersion:/Artalk.js>
->
-> <https://mirrors.sustech.edu.cn/cdnjs/ajax/libs/artalk/:ArtalkVersion:/Artalk.css>
-
-**Staticfile CDN (境内)**
-
-> <https://cdn.staticfile.org/artalk/:ArtalkVersion:/Artalk.js>
->
-> <https://cdn.staticfile.org/artalk/:ArtalkVersion:/Artalk.css>
-
-**UNPKG**
-
-> <https://unpkg.com/artalk@:ArtalkVersion:/dist/Artalk.js>
->
-> <https://unpkg.com/artalk@:ArtalkVersion:/dist/Artalk.css>
-
-**JS DELIVR**
-
-> <https://cdn.jsdelivr.net/npm/artalk@:ArtalkVersion:/dist/Artalk.js>
->
-> <https://cdn.jsdelivr.net/npm/artalk@:ArtalkVersion:/dist/Artalk.css>
-
-:::
-
-## Node 项目
-
-安装 Artalk：
-
-```bash
-npm install artalk
-```
-
-引入 Artalk：
-
-```js
-import 'artalk/dist/Artalk.css'
-import Artalk from 'artalk'
-
-Artalk.init({
-  // ...
-})
-```
-
-更多参考：
-
-- [置入博客文档](../develop/import-blog.md)
-- [置入框架文档](../develop/import-framework.md)
-- [前端配置](./frontend/config.md)
-- [前端 API](../develop/fe-api.md)
-
-## 数据导入
-
-从其他评论系统导入数据：[数据迁移](./transfer.md)
-
-## ArtalkLite
-
-可选择精简版 [ArtalkLite](./frontend/artalk-lite.md)：体积更小、更简约。
-
-## 开发环境
-
-可参考：[开发者指南](https://github.com/ArtalkJS/Artalk/blob/master/CONTRIBUTING.md)

docs/docs/guide/env.md

@@ -1,360 +0,0 @@
-# 环境变量
-
-Artalk 支持通过环境变量修改配置，这使得 Docker 等容器化云部署变得简单。
-
-环境变量名以 `ATK_` 开头，全大写，对应[配置文件](./backend/config.md)中的每个节点。
-
-环境变量的优先级高于配置文件，通过以下命令验证配置是否生效：
-  
-```bash
-artalk config
-```
-
-使用 Docker Compose 部署 Artalk，可在 `compose.yml` 文件添加环境变量，例如：
-
-```yaml
-version: '3.8'
-services:
-  artalk:
-    container_name: artalk
-    image: artalk/artalk-go
-    restart: unless-stopped
-    ports:
-      - 8080:23366
-    volumes:
-      - ./data:/data
-    environment:
-      - TZ=Asia/Shanghai
-      - ATK_LOCALE=zh-CN
-      - ATK_SITE_DEFAULT=Artalk 的博客
-      - ATK_SITE_URL=https://example.com
-      - ATK_TRUSTED_DOMAINS=https://dev.example.com https://localhost:8080
-      - ATK_ADMIN_USERS_0_NAME=admin
-      - ATK_ADMIN_USERS_0_EMAIL=admin@example.org
-      - ATK_ADMIN_USERS_0_PASSWORD=(bcrypt)$2y$10$ti4vZYIrxVN8rLcYXVgXCO.GJND0dyI49r7IoF3xqIx8bBRmIBZRm
-      - ATK_ADMIN_USERS_0_BADGE_NAME=管理员
-      - ATK_ADMIN_USERS_0_BADGE_COLOR=#0083FF
-```
-
-当变量为数组，通过空格分隔的字符串或数字索引来设置数组值，例如：
-
-```
-ATK_TRUSTED_DOMAINS="https://a.com https://b.com"
-ATK_TRUSTED_DOMAINS_0="https://a.com"
-```
-
-<style>
-.env-table table {
-  table-layout: fixed;
-  word-break: break-word;
-  
-  th:first-of-type, td:first-of-type {
-    width: 30%;
-  }
-  th:nth-of-type(2), td:nth-of-type(2) {
-    width: 20%;
-  }
-  th:nth-of-type(3), td:nth-of-type(3) {
-    width: 20%;
-  }
-  th:nth-of-type(4), td:nth-of-type(4) {
-    width: 30%;
-  }
-}
-</style>
-
-<div class="env-table">
-<!-- env-variables -->
-
-## 通用配置
-
-| 环境变量 | 默认值 | 描述 | 路径 |
-| --- | --- | --- | --- |
-| **ATK_ADMIN_USERS** | `[]` | 管理员账户 | admin_users (管理员账户) |
-| **ATK_APP_KEY** | `""` | 加密密钥 | app_key (加密密钥) |
-| **ATK_DEBUG** | `false` | 调试模式 | debug (调试模式) |
-| **ATK_HOST** | `"0.0.0.0"` | 服务器地址 | host (服务器地址) |
-| **ATK_LOCALE** | `"zh-CN"` | 语言 (可选：`["en", "zh-CN", "zh-TW", "ja", "fr", "ko", "ru"]`) | locale (语言) |
-| **ATK_LOGIN_TIMEOUT** | `259200` | 登录有效时长 (单位：秒) | login_timeout (登录有效时长) |
-| **ATK_PORT** | `23366` | 服务器端口 | port (服务器端口) |
-| **ATK_SITE_DEFAULT** | `"默认站点"` | 默认站点名 | site_default (默认站点名) |
-| **ATK_SITE_URL** | `""` | 默认站点地址 | site_url (默认站点地址) |
-| **ATK_TIMEZONE** | `"Asia/Shanghai"` | 时间区域 | timezone (时间区域) |
-| **ATK_TRUSTED_DOMAINS** | `[]` | 可信域名 | trusted_domains (可信域名) |
-
-
-## 多元推送
-
-| 环境变量 | 默认值 | 描述 | 路径 |
-| --- | --- | --- | --- |
-| **ATK_ADMIN_NOTIFY_BARK_ENABLED** | `false` | 启用 | admin_notify.bark.enabled (多元推送 > Bark > Enabled) |
-| **ATK_ADMIN_NOTIFY_BARK_SERVER** | `"http://day.app/xxxxxxx/"` | Server | admin_notify.bark.server (多元推送 > Bark > Server) |
-| **ATK_ADMIN_NOTIFY_DING_TALK_ENABLED** | `false` | 启用 | admin_notify.ding_talk.enabled (多元推送 > 钉钉 > Enabled) |
-| **ATK_ADMIN_NOTIFY_DING_TALK_SECRET** | `""` | Secret | admin_notify.ding_talk.secret (多元推送 > 钉钉 > Secret) |
-| **ATK_ADMIN_NOTIFY_DING_TALK_TOKEN** | `""` | Token | admin_notify.ding_talk.token (多元推送 > 钉钉 > Token) |
-| **ATK_ADMIN_NOTIFY_EMAIL_ENABLED** | `true` | 开启 (当使用其他推送方式时，可以关闭管理员邮件通知) | admin_notify.email.enabled (多元推送 > 邮件通知管理员 > 开启) |
-| **ATK_ADMIN_NOTIFY_EMAIL_MAIL_SUBJECT** | `"[{{site_name}}] 您的文章「{{page_title}}」有新回复"` | 邮件标题 (发送给管理员的邮件标题) | admin_notify.email.mail_subject (多元推送 > 邮件通知管理员 > 邮件标题) |
-| **ATK_ADMIN_NOTIFY_EMAIL_MAIL_TPL** | `""` | 管理员邮件模板文件 (填入文件路径使用自定义模板) | admin_notify.email.mail_tpl (多元推送 > 邮件通知管理员 > 管理员邮件模板文件) |
-| **ATK_ADMIN_NOTIFY_LARK_ENABLED** | `false` | 启用 | admin_notify.lark.enabled (多元推送 > 飞书 > Enabled) |
-| **ATK_ADMIN_NOTIFY_LARK_MSG_TYPE** | `"text"` | 消息类型 (可选：`["text", "card"]`) | admin_notify.lark.msg_type (多元推送 > 飞书 > 消息类型) |
-| **ATK_ADMIN_NOTIFY_LARK_WEBHOOK_URL** | `""` | WebhookUrl | admin_notify.lark.webhook_url (多元推送 > 飞书 > WebhookUrl) |
-| **ATK_ADMIN_NOTIFY_LINE_CHANNEL_ACCESS_TOKEN** | `""` | ChannelAccessToken | admin_notify.line.channel_access_token (多元推送 > LINE > ChannelAccessToken) |
-| **ATK_ADMIN_NOTIFY_LINE_CHANNEL_SECRET** | `""` | ChannelSecret | admin_notify.line.channel_secret (多元推送 > LINE > ChannelSecret) |
-| **ATK_ADMIN_NOTIFY_LINE_ENABLED** | `false` | 启用 | admin_notify.line.enabled (多元推送 > LINE > Enabled) |
-| **ATK_ADMIN_NOTIFY_LINE_RECEIVERS** | `[USER_ID_1 GROUP_ID_1]` | Receivers | admin_notify.line.receivers (多元推送 > LINE > Receivers) |
-| **ATK_ADMIN_NOTIFY_NOISE_MODE** | `false` | 嘈杂模式 | admin_notify.noise_mode (多元推送 > 嘈杂模式) |
-| **ATK_ADMIN_NOTIFY_NOTIFY_PENDING** | `false` | 待审评论仍然发送通知 (当评论被拦截时仍然发送通知) | admin_notify.notify_pending (多元推送 > 待审评论仍然发送通知) |
-| **ATK_ADMIN_NOTIFY_NOTIFY_TPL** | `"default"` | 通知模版 (填入文件路径使用自定义模板) | admin_notify.notify_tpl (多元推送 > 通知模版) |
-| **ATK_ADMIN_NOTIFY_SLACK_ENABLED** | `false` | 启用 | admin_notify.slack.enabled (多元推送 > Slack > Enabled) |
-| **ATK_ADMIN_NOTIFY_SLACK_OAUTH_TOKEN** | `""` | OauthToken | admin_notify.slack.oauth_token (多元推送 > Slack > OauthToken) |
-| **ATK_ADMIN_NOTIFY_SLACK_RECEIVERS** | `[CHANNEL_ID]` | Receivers | admin_notify.slack.receivers (多元推送 > Slack > Receivers) |
-| **ATK_ADMIN_NOTIFY_TELEGRAM_API_TOKEN** | `""` | ApiToken | admin_notify.telegram.api_token (多元推送 > Telegram > ApiToken) |
-| **ATK_ADMIN_NOTIFY_TELEGRAM_ENABLED** | `false` | 启用 | admin_notify.telegram.enabled (多元推送 > Telegram > Enabled) |
-| **ATK_ADMIN_NOTIFY_TELEGRAM_RECEIVERS** | `[7777777]` | Receivers | admin_notify.telegram.receivers (多元推送 > Telegram > Receivers) |
-| **ATK_ADMIN_NOTIFY_WEBHOOK_ENABLED** | `false` | 启用 | admin_notify.webhook.enabled (多元推送 > WebHook > Enabled) |
-| **ATK_ADMIN_NOTIFY_WEBHOOK_URL** | `""` | Url | admin_notify.webhook.url (多元推送 > WebHook > Url) |
-
-
-## 社交登录
-
-| 环境变量 | 默认值 | 描述 | 路径 |
-| --- | --- | --- | --- |
-| **ATK_AUTH_ANONYMOUS** | `false` | 允许匿名评论 (允许跳过验证，仅填写匿名的昵称和邮箱) | auth.anonymous (社交登录 > 允许匿名评论) |
-| **ATK_AUTH_APPLE_CLIENT_ID** | `""` | ClientId | auth.apple.client_id (社交登录 > Apple > ClientId) |
-| **ATK_AUTH_APPLE_CLIENT_SECRET** | `""` | ClientSecret | auth.apple.client_secret (社交登录 > Apple > ClientSecret) |
-| **ATK_AUTH_APPLE_ENABLED** | `false` | 启用 | auth.apple.enabled (社交登录 > Apple > Enabled) |
-| **ATK_AUTH_AUTH0_CLIENT_ID** | `""` | ClientId | auth.auth0.client_id (社交登录 > Auth0 > ClientId) |
-| **ATK_AUTH_AUTH0_CLIENT_SECRET** | `""` | ClientSecret | auth.auth0.client_secret (社交登录 > Auth0 > ClientSecret) |
-| **ATK_AUTH_AUTH0_DOMAIN** | `""` | Domain | auth.auth0.domain (社交登录 > Auth0 > Domain) |
-| **ATK_AUTH_AUTH0_ENABLED** | `false` | 启用 | auth.auth0.enabled (社交登录 > Auth0 > Enabled) |
-| **ATK_AUTH_CALLBACK** | `"http://localhost:23366/api/v2/auth/{provider}/callback"` | 回调地址 (https://example.com/api/v2/auth/{provider}/callback) | auth.callback (社交登录 > 回调地址) |
-| **ATK_AUTH_DISCORD_CLIENT_ID** | `""` | ClientId | auth.discord.client_id (社交登录 > Discord > ClientId) |
-| **ATK_AUTH_DISCORD_CLIENT_SECRET** | `""` | ClientSecret | auth.discord.client_secret (社交登录 > Discord > ClientSecret) |
-| **ATK_AUTH_DISCORD_ENABLED** | `false` | 启用 | auth.discord.enabled (社交登录 > Discord > Enabled) |
-| **ATK_AUTH_EMAIL_ENABLED** | `true` | 启用邮箱密码登录 | auth.email.enabled (社交登录 > Email > 启用邮箱密码登录) |
-| **ATK_AUTH_EMAIL_VERIFY_SUBJECT** | `"您的验证码是 - {{code}}"` | 邮箱验证邮件标题 | auth.email.verify_subject (社交登录 > Email > 邮箱验证邮件标题) |
-| **ATK_AUTH_EMAIL_VERIFY_TPL** | `"default"` | 邮箱验证邮件模板 (填入文件路径使用自定义模板) | auth.email.verify_tpl (社交登录 > Email > 邮箱验证邮件模板) |
-| **ATK_AUTH_ENABLED** | `false` | 启用社交登录 | auth.enabled (社交登录 > 启用社交登录) |
-| **ATK_AUTH_FACEBOOK_CLIENT_ID** | `""` | ClientId | auth.facebook.client_id (社交登录 > Facebook > ClientId) |
-| **ATK_AUTH_FACEBOOK_CLIENT_SECRET** | `""` | ClientSecret | auth.facebook.client_secret (社交登录 > Facebook > ClientSecret) |
-| **ATK_AUTH_FACEBOOK_ENABLED** | `false` | 启用 | auth.facebook.enabled (社交登录 > Facebook > Enabled) |
-| **ATK_AUTH_GITEA_CLIENT_ID** | `""` | ClientId | auth.gitea.client_id (社交登录 > Gitea > ClientId) |
-| **ATK_AUTH_GITEA_CLIENT_SECRET** | `""` | ClientSecret | auth.gitea.client_secret (社交登录 > Gitea > ClientSecret) |
-| **ATK_AUTH_GITEA_ENABLED** | `false` | 启用 | auth.gitea.enabled (社交登录 > Gitea > Enabled) |
-| **ATK_AUTH_GITHUB_CLIENT_ID** | `""` | ClientId | auth.github.client_id (社交登录 > GitHub > ClientId) |
-| **ATK_AUTH_GITHUB_CLIENT_SECRET** | `""` | ClientSecret | auth.github.client_secret (社交登录 > GitHub > ClientSecret) |
-| **ATK_AUTH_GITHUB_ENABLED** | `false` | 启用 | auth.github.enabled (社交登录 > GitHub > Enabled) |
-| **ATK_AUTH_GITLAB_CLIENT_ID** | `""` | ClientId | auth.gitlab.client_id (社交登录 > GitLab > ClientId) |
-| **ATK_AUTH_GITLAB_CLIENT_SECRET** | `""` | ClientSecret | auth.gitlab.client_secret (社交登录 > GitLab > ClientSecret) |
-| **ATK_AUTH_GITLAB_ENABLED** | `false` | 启用 | auth.gitlab.enabled (社交登录 > GitLab > Enabled) |
-| **ATK_AUTH_GOOGLE_CLIENT_ID** | `""` | ClientId | auth.google.client_id (社交登录 > Google > ClientId) |
-| **ATK_AUTH_GOOGLE_CLIENT_SECRET** | `""` | ClientSecret | auth.google.client_secret (社交登录 > Google > ClientSecret) |
-| **ATK_AUTH_GOOGLE_ENABLED** | `false` | 启用 | auth.google.enabled (社交登录 > Google > Enabled) |
-| **ATK_AUTH_LINE_CLIENT_ID** | `""` | ClientId | auth.line.client_id (社交登录 > Line > ClientId) |
-| **ATK_AUTH_LINE_CLIENT_SECRET** | `""` | ClientSecret | auth.line.client_secret (社交登录 > Line > ClientSecret) |
-| **ATK_AUTH_LINE_ENABLED** | `false` | 启用 | auth.line.enabled (社交登录 > Line > Enabled) |
-| **ATK_AUTH_MASTODON_CLIENT_ID** | `""` | ClientId | auth.mastodon.client_id (社交登录 > Mastodon > ClientId) |
-| **ATK_AUTH_MASTODON_CLIENT_SECRET** | `""` | ClientSecret | auth.mastodon.client_secret (社交登录 > Mastodon > ClientSecret) |
-| **ATK_AUTH_MASTODON_ENABLED** | `false` | 启用 | auth.mastodon.enabled (社交登录 > Mastodon > Enabled) |
-| **ATK_AUTH_MICROSOFT_CLIENT_ID** | `""` | ClientId | auth.microsoft.client_id (社交登录 > Microsoft > ClientId) |
-| **ATK_AUTH_MICROSOFT_CLIENT_SECRET** | `""` | ClientSecret | auth.microsoft.client_secret (社交登录 > Microsoft > ClientSecret) |
-| **ATK_AUTH_MICROSOFT_ENABLED** | `false` | 启用 | auth.microsoft.enabled (社交登录 > Microsoft > Enabled) |
-| **ATK_AUTH_PATREON_CLIENT_ID** | `""` | ClientId | auth.patreon.client_id (社交登录 > Patreon > ClientId) |
-| **ATK_AUTH_PATREON_CLIENT_SECRET** | `""` | ClientSecret | auth.patreon.client_secret (社交登录 > Patreon > ClientSecret) |
-| **ATK_AUTH_PATREON_ENABLED** | `false` | 启用 | auth.patreon.enabled (社交登录 > Patreon > Enabled) |
-| **ATK_AUTH_SLACK_CLIENT_ID** | `""` | ClientId | auth.slack.client_id (社交登录 > Slack > ClientId) |
-| **ATK_AUTH_SLACK_CLIENT_SECRET** | `""` | ClientSecret | auth.slack.client_secret (社交登录 > Slack > ClientSecret) |
-| **ATK_AUTH_SLACK_ENABLED** | `false` | 启用 | auth.slack.enabled (社交登录 > Slack > Enabled) |
-| **ATK_AUTH_STEAM_API_KEY** | `""` | ApiKey | auth.steam.api_key (社交登录 > Steam > ApiKey) |
-| **ATK_AUTH_STEAM_ENABLED** | `false` | 启用 | auth.steam.enabled (社交登录 > Steam > Enabled) |
-| **ATK_AUTH_TIKTOK_CLIENT_ID** | `""` | ClientId | auth.tiktok.client_id (社交登录 > Tiktok > ClientId) |
-| **ATK_AUTH_TIKTOK_CLIENT_SECRET** | `""` | ClientSecret | auth.tiktok.client_secret (社交登录 > Tiktok > ClientSecret) |
-| **ATK_AUTH_TIKTOK_ENABLED** | `false` | 启用 | auth.tiktok.enabled (社交登录 > Tiktok > Enabled) |
-| **ATK_AUTH_TWITTER_CLIENT_ID** | `""` | ClientId | auth.twitter.client_id (社交登录 > Twitter > ClientId) |
-| **ATK_AUTH_TWITTER_CLIENT_SECRET** | `""` | ClientSecret | auth.twitter.client_secret (社交登录 > Twitter > ClientSecret) |
-| **ATK_AUTH_TWITTER_ENABLED** | `false` | 启用 | auth.twitter.enabled (社交登录 > Twitter > Enabled) |
-| **ATK_AUTH_WECHAT_CLIENT_ID** | `""` | ClientId | auth.wechat.client_id (社交登录 > 微信 > ClientId) |
-| **ATK_AUTH_WECHAT_CLIENT_SECRET** | `""` | ClientSecret | auth.wechat.client_secret (社交登录 > 微信 > ClientSecret) |
-| **ATK_AUTH_WECHAT_ENABLED** | `false` | 启用 | auth.wechat.enabled (社交登录 > 微信 > Enabled) |
-
-
-## 缓存
-
-| 环境变量 | 默认值 | 描述 | 路径 |
-| --- | --- | --- | --- |
-| **ATK_CACHE_ENABLED** | `false` | 启用缓存 | cache.enabled (缓存 > 启用缓存) |
-| **ATK_CACHE_EXPIRES** | `30` | 缓存过期时间 (单位：分钟) | cache.expires (缓存 > 缓存过期时间) |
-| **ATK_CACHE_REDIS_DB** | `0` | 数据库编号 (例如使用零号数据库填写 0) | cache.redis.db (缓存 > Redis 配置 > 数据库编号) |
-| **ATK_CACHE_REDIS_NETWORK** | `"tcp"` | 连接方式 (可选：`["tcp", "unix"]`) | cache.redis.network (缓存 > Redis 配置 > 连接方式) |
-| **ATK_CACHE_REDIS_PASSWORD** | `""` | 密码 | cache.redis.password (缓存 > Redis 配置 > 密码) |
-| **ATK_CACHE_REDIS_USERNAME** | `""` | 用户名 | cache.redis.username (缓存 > Redis 配置 > 用户名) |
-| **ATK_CACHE_SERVER** | `""` | 缓存服务器地址 (例如："localhost:6379") | cache.server (缓存 > 缓存服务器地址) |
-| **ATK_CACHE_TYPE** | `"builtin"` | 缓存类型 (可选：`["redis", "memcache", "builtin"]`) | cache.type (缓存 > 缓存类型) |
-| **ATK_CACHE_WARM_UP** | `false` | 缓存启动预热 (程序启动时预热缓存) | cache.warm_up (缓存 > 缓存启动预热) |
-
-
-## 验证码
-
-| 环境变量 | 默认值 | 描述 | 路径 |
-| --- | --- | --- | --- |
-| **ATK_CAPTCHA_ACTION_LIMIT** | `3` | 激活验证码所需操作次数 | captcha.action_limit (验证码 > 激活验证码所需操作次数) |
-| **ATK_CAPTCHA_ACTION_RESET** | `60` | 重置操作计数器超时 (单位：s, 设为 -1 不重置) | captcha.action_reset (验证码 > 重置操作计数器超时) |
-| **ATK_CAPTCHA_ALWAYS** | `false` | 总是需要验证码 | captcha.always (验证码 > 总是需要验证码) |
-| **ATK_CAPTCHA_CAPTCHA_TYPE** | `"image"` | 验证类型 (可选：`["image", "turnstile", "recaptcha", "hcaptcha", "geetest"]`) | captcha.captcha_type (验证码 > 验证类型) |
-| **ATK_CAPTCHA_ENABLED** | `true` | 启用验证码 | captcha.enabled (验证码 > 启用验证码) |
-| **ATK_CAPTCHA_GEETEST_CAPTCHA_ID** | `""` | CaptchaId | captcha.geetest.captcha_id (验证码 > Geetest 极验 > CaptchaId) |
-| **ATK_CAPTCHA_GEETEST_CAPTCHA_KEY** | `""` | CaptchaKey | captcha.geetest.captcha_key (验证码 > Geetest 极验 > CaptchaKey) |
-| **ATK_CAPTCHA_HCAPTCHA_SECRET_KEY** | `""` | SecretKey | captcha.hcaptcha.secret_key (验证码 > hCaptcha > SecretKey) |
-| **ATK_CAPTCHA_HCAPTCHA_SITE_KEY** | `""` | SiteKey | captcha.hcaptcha.site_key (验证码 > hCaptcha > SiteKey) |
-| **ATK_CAPTCHA_RECAPTCHA_SECRET_KEY** | `""` | SecretKey | captcha.recaptcha.secret_key (验证码 > reCaptcha > SecretKey) |
-| **ATK_CAPTCHA_RECAPTCHA_SITE_KEY** | `""` | SiteKey | captcha.recaptcha.site_key (验证码 > reCaptcha > SiteKey) |
-| **ATK_CAPTCHA_TURNSTILE_SECRET_KEY** | `""` | SecretKey | captcha.turnstile.secret_key (验证码 > Turnstile > SecretKey) |
-| **ATK_CAPTCHA_TURNSTILE_SITE_KEY** | `""` | SiteKey | captcha.turnstile.site_key (验证码 > Turnstile > SiteKey) |
-
-
-## 数据库
-
-| 环境变量 | 默认值 | 描述 | 路径 |
-| --- | --- | --- | --- |
-| **ATK_DB_CHARSET** | `"utf8mb4"` | 编码格式 | db.charset (数据库 > 编码格式) |
-| **ATK_DB_FILE** | `"./data/artalk.db"` | 数据库文件 (仅 SQLite 数据库需填写) | db.file (数据库 > 数据库文件) |
-| **ATK_DB_HOST** | `"localhost"` | 数据库地址 | db.host (数据库 > 数据库地址) |
-| **ATK_DB_NAME** | `"artalk"` | 数据库名称 | db.name (数据库 > 数据库名称) |
-| **ATK_DB_PASSWORD** | `""` | 数据库密码 | db.password (数据库 > 数据库密码) |
-| **ATK_DB_PORT** | `3306` | 数据库端口 | db.port (数据库 > 数据库端口) |
-| **ATK_DB_PREPARE_STMT** | `true` | 预编译语句 | db.prepare_stmt (数据库 > 预编译语句) |
-| **ATK_DB_SSL** | `false` | 启用 SSL | db.ssl (数据库 > 启用 SSL) |
-| **ATK_DB_TABLE_PREFIX** | `""` | 表前缀 (例如："atk_") | db.table_prefix (数据库 > 表前缀) |
-| **ATK_DB_TYPE** | `"sqlite"` | 数据库类型 (可选：`["sqlite", "mysql", "pgsql", "mssql"]`) | db.type (数据库 > 数据库类型) |
-| **ATK_DB_USER** | `"root"` | 数据库账户 | db.user (数据库 > 数据库账户) |
-
-
-## 邮件通知
-
-| 环境变量 | 默认值 | 描述 | 路径 |
-| --- | --- | --- | --- |
-| **ATK_EMAIL_ALI_DM_ACCESS_KEY_ID** | `""` | AccessKeyId | email.ali_dm.access_key_id (邮件通知 > 阿里云邮件推送 > AccessKeyId) |
-| **ATK_EMAIL_ALI_DM_ACCESS_KEY_SECRET** | `""` | AccessKeySecret | email.ali_dm.access_key_secret (邮件通知 > 阿里云邮件推送 > AccessKeySecret) |
-| **ATK_EMAIL_ALI_DM_ACCOUNT_NAME** | `"noreply@example.com"` | AccountName | email.ali_dm.account_name (邮件通知 > 阿里云邮件推送 > AccountName) |
-| **ATK_EMAIL_ENABLED** | `false` | 启用邮件通知 | email.enabled (邮件通知 > 启用邮件通知) |
-| **ATK_EMAIL_MAIL_SUBJECT** | `"[{{site_name}}] 您收到了来自 @{{reply_nick}} 的回复"` | 邮件标题 | email.mail_subject (邮件通知 > 邮件标题) |
-| **ATK_EMAIL_MAIL_TPL** | `"default"` | 邮件模板文件 (填入文件路径使用自定义模板) | email.mail_tpl (邮件通知 > 邮件模板文件) |
-| **ATK_EMAIL_SEND_ADDR** | `"noreply@example.com"` | 发信人地址 | email.send_addr (邮件通知 > 发信人地址) |
-| **ATK_EMAIL_SEND_NAME** | `"{{reply_nick}}"` | 发信人昵称 | email.send_name (邮件通知 > 发信人昵称) |
-| **ATK_EMAIL_SEND_TYPE** | `"smtp"` | 发送方式 (可选：`["smtp", "ali_dm", "sendmail"]`) | email.send_type (邮件通知 > 发送方式) |
-| **ATK_EMAIL_SMTP_HOST** | `"smtp.qq.com"` | 发件地址 | email.smtp.host (邮件通知 > SMTP 发送 > 发件地址) |
-| **ATK_EMAIL_SMTP_PASSWORD** | `""` | 密码 | email.smtp.password (邮件通知 > SMTP 发送 > 密码) |
-| **ATK_EMAIL_SMTP_PORT** | `587` | 发件端口 | email.smtp.port (邮件通知 > SMTP 发送 > 发件端口) |
-| **ATK_EMAIL_SMTP_USERNAME** | `"example@qq.com"` | 用户名 | email.smtp.username (邮件通知 > SMTP 发送 > 用户名) |
-
-
-## 界面配置
-
-| 环境变量 | 默认值 | 描述 | 路径 |
-| --- | --- | --- | --- |
-| **ATK_FRONTEND_DARKMODE** | `"inherit"` | 夜间模式 (可选：`["inherit", "auto"]`) | frontend.darkMode (界面配置 > 夜间模式) |
-| **ATK_FRONTEND_EDITORTRAVEL** | `true` | 评论框穿梭 | frontend.editorTravel (界面配置 > 评论框穿梭) |
-| **ATK_FRONTEND_EMOTICONS** | `"https://cdn.jsdelivr.net/gh/ArtalkJS/Emoticons/grps/default.json"` | 表情包 | frontend.emoticons (界面配置 > 表情包) |
-| **ATK_FRONTEND_FLATMODE** | `"auto"` | 平铺模式 (可选：`["auto", "true", "false"]`) | frontend.flatMode (界面配置 > 平铺模式) |
-| **ATK_FRONTEND_GRAVATAR_MIRROR** | `"https://weavatar.com/avatar/"` | API 地址 | frontend.gravatar.mirror (界面配置 > 头像 Gravatar > API 地址) |
-| **ATK_FRONTEND_GRAVATAR_PARAMS** | `"sha256=1&d=mp&s=240"` | API 参数 | frontend.gravatar.params (界面配置 > 头像 Gravatar > API 参数) |
-| **ATK_FRONTEND_HEIGHTLIMIT_CHILDREN** | `400` | 子评论区域限高 (单位：px) | frontend.heightLimit.children (界面配置 > 内容限高 > 子评论区域限高) |
-| **ATK_FRONTEND_HEIGHTLIMIT_CONTENT** | `300` | 评论内容限高 (单位：px) | frontend.heightLimit.content (界面配置 > 内容限高 > 评论内容限高) |
-| **ATK_FRONTEND_HEIGHTLIMIT_SCROLLABLE** | `false` | 滚动限高 (允许限高区域滚动) | frontend.heightLimit.scrollable (界面配置 > 内容限高 > 滚动限高) |
-| **ATK_FRONTEND_IMGLAZYLOAD** | `false` | 图片懒加载 (可选：`["false", "native", "data-src"]`) | frontend.imgLazyLoad (界面配置 > 图片懒加载) |
-| **ATK_FRONTEND_LISTSORT** | `true` | 评论排序功能 | frontend.listSort (界面配置 > 评论排序功能) |
-| **ATK_FRONTEND_NESTMAX** | `2` | 最大嵌套层数 | frontend.nestMax (界面配置 > 最大嵌套层数) |
-| **ATK_FRONTEND_NESTSORT** | `"DATE_ASC"` | 嵌套评论排序规则 (可选：`["DATE_ASC", "DATE_DESC", "VOTE_UP_DESC"]`) | frontend.nestSort (界面配置 > 嵌套评论排序规则) |
-| **ATK_FRONTEND_NOCOMMENT** | `""` | 无评论显示文字 | frontend.noComment (界面配置 > 无评论显示文字) |
-| **ATK_FRONTEND_PAGINATION_AUTOLOAD** | `true` | 滚动加载 | frontend.pagination.autoLoad (界面配置 > 评论分页 > 滚动加载) |
-| **ATK_FRONTEND_PAGINATION_PAGESIZE** | `20` | 每页评论数 | frontend.pagination.pageSize (界面配置 > 评论分页 > 每页评论数) |
-| **ATK_FRONTEND_PAGINATION_READMORE** | `true` | 加载更多模式 (关闭则使用分页条) | frontend.pagination.readMore (界面配置 > 评论分页 > 加载更多模式) |
-| **ATK_FRONTEND_PLACEHOLDER** | `""` | 评论框占位文字 | frontend.placeholder (界面配置 > 评论框占位文字) |
-| **ATK_FRONTEND_PLUGINURLS** | `[]` | 插件 | frontend.pluginURLs (界面配置 > 插件) |
-| **ATK_FRONTEND_PREVIEW** | `true` | 编辑器实时预览功能 | frontend.preview (界面配置 > 编辑器实时预览功能) |
-| **ATK_FRONTEND_REQTIMEOUT** | `15000` | 请求超时 (单位：毫秒) | frontend.reqTimeout (界面配置 > 请求超时) |
-| **ATK_FRONTEND_SENDBTN** | `""` | 发送按钮文字 | frontend.sendBtn (界面配置 > 发送按钮文字) |
-| **ATK_FRONTEND_UABADGE** | `false` | 用户 UA 徽标 | frontend.uaBadge (界面配置 > 用户 UA 徽标) |
-| **ATK_FRONTEND_VERSIONCHECK** | `true` | 版本检测 | frontend.versionCheck (界面配置 > 版本检测) |
-| **ATK_FRONTEND_VOTE** | `true` | 投票按钮 | frontend.vote (界面配置 > 投票按钮) |
-| **ATK_FRONTEND_VOTEDOWN** | `false` | 反对按钮 | frontend.voteDown (界面配置 > 反对按钮) |
-
-
-## 服务器
-
-| 环境变量 | 默认值 | 描述 | 路径 |
-| --- | --- | --- | --- |
-| **ATK_HTTP_BODY_LIMIT** | `100` | 请求体大小限制 (单位：MB) | http.body_limit (服务器 > 请求体大小限制) |
-| **ATK_HTTP_PROXY_HEADER** | `""` | 代理标头名 (当使用 CDN 时填写 `X-Forwarded-For` 获取用户真实 IP) | http.proxy_header (服务器 > 代理标头名) |
-
-
-## 图片上传
-
-| 环境变量 | 默认值 | 描述 | 路径 |
-| --- | --- | --- | --- |
-| **ATK_IMG_UPLOAD_ENABLED** | `true` | 启用图片上传 | img_upload.enabled (图片上传 > 启用图片上传) |
-| **ATK_IMG_UPLOAD_MAX_SIZE** | `5` | 图片大小限制 (单位：MB) | img_upload.max_size (图片上传 > 图片大小限制) |
-| **ATK_IMG_UPLOAD_PATH** | `"./data/artalk-img/"` | 图片存放路径 | img_upload.path (图片上传 > 图片存放路径) |
-| **ATK_IMG_UPLOAD_PUBLIC_PATH** | `<nil>` | 图片链接基础路径 (默认为 "/static/images/") | img_upload.public_path (图片上传 > 图片链接基础路径) |
-| **ATK_IMG_UPLOAD_UPGIT_DEL_LOCAL** | `true` | 上传后删除本地的图片 | img_upload.upgit.del_local (图片上传 > Upgit 配置 > 上传后删除本地的图片) |
-| **ATK_IMG_UPLOAD_UPGIT_ENABLED** | `false` | 启用 Upgit | img_upload.upgit.enabled (图片上传 > Upgit 配置 > 启用 Upgit) |
-| **ATK_IMG_UPLOAD_UPGIT_EXEC** | `"upgit -c <upgit配置文件路径> -t /artalk-img"` | 命令行参数 | img_upload.upgit.exec (图片上传 > Upgit 配置 > 命令行参数) |
-
-
-## IP 属地
-
-| 环境变量 | 默认值 | 描述 | 路径 |
-| --- | --- | --- | --- |
-| **ATK_IP_REGION_DB_PATH** | `"./data/ip2region.xdb"` | 数据文件路径 (.xdb 格式) | ip_region.db_path (IP 属地 > 数据文件路径) |
-| **ATK_IP_REGION_ENABLED** | `false` | 启用 IP 属地展示 | ip_region.enabled (IP 属地 > 启用 IP 属地展示) |
-| **ATK_IP_REGION_PRECISION** | `"province"` | 显示精度 (可选：`["province", "city", "country"]`) | ip_region.precision (IP 属地 > 显示精度) |
-
-
-## 日志
-
-| 环境变量 | 默认值 | 描述 | 路径 |
-| --- | --- | --- | --- |
-| **ATK_LOG_ENABLED** | `true` | 启用日志 | log.enabled (日志 > 启用日志) |
-| **ATK_LOG_FILENAME** | `"./data/artalk.log"` | 日志文件路径 | log.filename (日志 > 日志文件路径) |
-
-
-## 评论审核
-
-| 环境变量 | 默认值 | 描述 | 路径 |
-| --- | --- | --- | --- |
-| **ATK_MODERATOR_AKISMET_KEY** | `""` | Akismet Key (Akismet 反垃圾服务，https://akismet.com) | moderator.akismet_key (评论审核 > Akismet Key) |
-| **ATK_MODERATOR_ALIYUN_ACCESS_KEY_ID** | `""` | AccessKeyId | moderator.aliyun.access_key_id (评论审核 > 阿里云内容安全 > AccessKeyId) |
-| **ATK_MODERATOR_ALIYUN_ACCESS_KEY_SECRET** | `""` | AccessKeySecret | moderator.aliyun.access_key_secret (评论审核 > 阿里云内容安全 > AccessKeySecret) |
-| **ATK_MODERATOR_ALIYUN_ENABLED** | `false` | 启用 | moderator.aliyun.enabled (评论审核 > 阿里云内容安全 > Enabled) |
-| **ATK_MODERATOR_ALIYUN_REGION** | `"cn-shanghai"` | Region | moderator.aliyun.region (评论审核 > 阿里云内容安全 > Region) |
-| **ATK_MODERATOR_API_FAIL_BLOCK** | `false` | API 请求错误时拦截 (关闭此项当请求错误时让评论放行) | moderator.api_fail_block (评论审核 > API 请求错误时拦截) |
-| **ATK_MODERATOR_KEYWORDS_ENABLED** | `false` | 启用 | moderator.keywords.enabled (评论审核 > 关键词过滤 > Enabled) |
-| **ATK_MODERATOR_KEYWORDS_FILE_SEP** | `"\n"` | 词库文件内容分割符 (例如填写 "\n" 文件中一行一个关键词) | moderator.keywords.file_sep (评论审核 > 关键词过滤 > 词库文件内容分割符) |
-| **ATK_MODERATOR_KEYWORDS_FILES** | `[./data/词库_1.txt]` | 词库文件 (支持多个词库文件) | moderator.keywords.files (评论审核 > 关键词过滤 > 词库文件) |
-| **ATK_MODERATOR_KEYWORDS_PENDING** | `false` | 匹配成功设为待审状态 | moderator.keywords.pending (评论审核 > 关键词过滤 > 匹配成功设为待审状态) |
-| **ATK_MODERATOR_KEYWORDS_REPLACE_TO** | `"x"` | 替换字符 | moderator.keywords.replace_to (评论审核 > 关键词过滤 > 替换字符) |
-| **ATK_MODERATOR_PENDING_DEFAULT** | `false` | 默认待审 (发表新评论需要后台人工审核后才能显示) | moderator.pending_default (评论审核 > 默认待审) |
-| **ATK_MODERATOR_TENCENT_ENABLED** | `false` | 启用 | moderator.tencent.enabled (评论审核 > 腾讯云文本内容安全 > Enabled) |
-| **ATK_MODERATOR_TENCENT_REGION** | `"ap-guangzhou"` | Region | moderator.tencent.region (评论审核 > 腾讯云文本内容安全 > Region) |
-| **ATK_MODERATOR_TENCENT_SECRET_ID** | `""` | SecretId | moderator.tencent.secret_id (评论审核 > 腾讯云文本内容安全 > SecretId) |
-| **ATK_MODERATOR_TENCENT_SECRET_KEY** | `""` | SecretKey | moderator.tencent.secret_key (评论审核 > 腾讯云文本内容安全 > SecretKey) |
-
-
-## SSL
-
-| 环境变量 | 默认值 | 描述 | 路径 |
-| --- | --- | --- | --- |
-| **ATK_SSL_CERT_PATH** | `""` | 证书文件路径 | ssl.cert_path (SSL > 证书文件路径) |
-| **ATK_SSL_ENABLED** | `false` | 启用 SSL | ssl.enabled (SSL > 启用 SSL) |
-| **ATK_SSL_KEY_PATH** | `""` | 密钥文件路径 | ssl.key_path (SSL > 密钥文件路径) |
-
-<!-- /env-variables -->
-</div>
-
-## 开发者
-
-通过 `ATK_DEBUG=1` 启用开发者模式。
-
-本文档由 Artalk 开发者工具自动生成，执行 `make update-conf-docs` 根据模版配置文件 ([conf/artalk.example.zh-CN.yml](https://github.com/ArtalkJS/Artalk/tree/master/conf/artalk.example.zh-CN.yml)) 中的注释更新本页内容。
-
-相关代码位于 [@ArtalkJS/Artalk:/internal/config/](https://github.com/ArtalkJS/Artalk/tree/master/internal/config/) 目录。

docs/docs/guide/frontend/auth.md

@@ -1,76 +0,0 @@
-# 社交登录
-
-Artalk 默认只需填写昵称和邮箱即可发表评论，无需验证邮箱。
-
-但有时候，我们希望用户能够使用社交账号登录，以减少用户填写信息的时间，或者提高用户信息的真实性，可以通过启用社交登录来实现这一目的。
-
-社交登录目前支持以下多种方式：
-
-| 登录方式 | 接入文档 | 登录方式 | 接入文档 | 登录方式 | 接入文档 |
-| --- | --- | --- | --- | --- | --- |
-| Google | [查看](https://developers.google.com/identity/protocols/oauth2) | Microsoft | [查看](https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-auth-code-flow) | Apple | [查看](https://developer.apple.com/documentation/sign_in_with_apple/sign_in_with_apple_js/configuring_your_webpage_for_sign_in_with_apple) |
-| Facebook | [查看](https://developers.facebook.com/docs/facebook-login/) | Twitter | [查看](https://developer.twitter.com/en/docs/basics/authentication/overview) | Discord | [查看](https://discord.com/developers/docs/topics/oauth2) |
-| Slack | [查看](https://api.slack.com/authentication/oauth-v2) | Github | [查看](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/) | Tiktok | [查看](https://developers.tiktok.com/doc/login) |
-| Steam | [查看](https://partner.steamgames.com/doc/webapi_overview/auth) | WeChat | [查看](https://developers.weixin.qq.com/doc/oplatform/Website_App/WeChat_Login/Wechat_Login.html) | Line | [查看](https://developers.line.biz/en/docs/line-login/integrate-line-login/) |
-| GitLab | [查看](https://docs.gitlab.com/ee/api/oauth2.html) | Gitea | [查看](https://docs.gitea.io/en-us/oauth2-provider/) | Mastodon | [查看](https://docs.joinmastodon.org/api/authentication/) |
-| Patreon | [查看](https://docs.patreon.com/#oauth) | Auth0 | [查看](https://auth0.com/docs/connections/social/) | 邮箱密码 | [查看](#邮箱密码登录) |
-
-开启社交登录功能仅需在 [控制中心](/guide/frontend/sidebar.md#设置) 找到「社交登录」启用该功能，然后填写对应的配置信息即可。也可以通过 [配置文件](/guide/backend/config.md) 或 [环境变量](/guide/env.md#社交登录) 进行配置。
-
-
-## 邮箱密码登录
-
-![邮箱登录](../../images/auth/email_login.png)
-
-启用邮箱密码登录后，评论框顶部的昵称邮箱输入框将被隐藏，发送按钮将显示为登录按钮。用户点击登录按钮后，将会弹出一个登录框，用户可以输入邮箱和密码登录，登录成功后即可发表评论。并且，用户发表的评论将展示「邮箱已验证」的标识。
-
-<img src="../../images/auth/email_verified.png" width="550" alt="邮箱已验证标识">
-
-用户可以通过邮箱注册账号，Artalk 将向用户邮箱发送一封带有验证码的邮件。验证码有效期为 10 分钟，验证码发送频率限制为 1 分钟一次。
-
-![邮箱注册](../../images/auth/email_register.png)
-
-支持自定义验证码邮件模板和邮件标题，可在 Artalk 控制中心的设置页面的社交登录找到「邮箱验证邮件标题」、「邮箱验证邮件模板」选项进行设置。在配置文件中，可以通过 `auth.email.verify_subject` 和 `auth.email.verify_tpl` 进行设置：
-
-```yaml
-auth:
-  enabled: true
-  email:
-    enabled: true
-    verify_subject: "您的验证码是 - {{code}}"
-    verify_tpl: default
-```
-
-默认模版如下：
-
-```html
-您的验证码是：{{code}}。请使用它来验证您的电子邮件并登录到 Artalk。如果您没有请求此操作，请忽略此消息。
-```
-
-![跳过登录](../../images/auth/login_skip.png)
-
-启用邮箱密码登录功能后，仍然可跳过邮箱验证：登录弹窗底部显示 “跳过，不验证” 按钮，点击后评论框顶部恢复为显示原有的昵称、邮箱、网址三个输入框。在设置中勾选「允许匿名评论」可以更改。
-
-## 账号合并工具
-
-登录后如果检测到相同的邮箱下有多个不同用户名的账号，将会弹出账号合并工具，用户可以选择保留其中一个用户名，该邮箱下的所有评论等数据合并到保留的账号下。原有的账号将被删除，评论显示的用户名将会变更为保留的用户名。
-
-![账号合并工具](../../images/auth/merge_accounts.png)
-
-## 多种登录方式
-
-Artalk 支持同时启用多种登录方式，用户可以选择任意一种方式登录。
-
-![多种登录方式](../../images/auth/multi_login.png)
-
-如果只启用了唯一一种登录，例如 GitHub 登录，将直接弹出 GitHub 的授权登录页面。
-
-![GitHub 授权弹窗](../../images/auth/github_login.png)
-
-接入 GitHub 登录可参考文档：[关于创建 GitHub 应用](https://docs.github.com/zh/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps)，得到 Client ID 和 Client Secret 后，填写到 Artalk 控制中心的设置页面的社交登录中的「GitHub」选项中即可。
-
-## 插件开发
-
-Artalk 的社交登录功能是通过独立的插件实现并采用 Solid.js 开发，代码可在 [@ArtalkJS/Artalk:ui/plugin-auth](https://github.com/ArtalkJS/Artalk/tree/master/ui/plugin-auth) 找到。
-
-在控制中心启用社交登录功能后，将自动在前端加载该插件。

docs/docs/guide/frontend/emoticons.md

@@ -1,179 +0,0 @@
-# 表情包
-
-你可以在 [控制中心](/guide/frontend/sidebar.md#设置) 的设置界面修改此配置，也可以通过 [配置文件](../backend/config.md#界面配置-frontend) 或 [环境变量](../env.md#界面配置) 进行配置。
-
-在配置文件中，可在 `frontend.emoticons` 填入表情包列表 URL：
-
-```yaml
-frontend:
-  emoticons: https://raw.githubusercontent.com/ArtalkJS/Emoticons/master/grps/default.json
-```
-
-## 表情包预设
-
-Artalk 社区提供许多表情包预设，你能够挑选几套喜欢的表情包，仅需简单的配置，轻松添加到你的评论系统中，前往仓库：[@ArtalkJS/Emoticons](https://github.com/ArtalkJS/Emoticons)。
-
-## 格式支持
-
-### OwO 格式
-
-[OwO](https://github.com/DIYgod/OwO) 是作者 [@DIYgod](https://github.com/DIYgod) 开发的开源 JS 插件，能让输入框快速拥有插入表情符号的功能。
-
-Artalk 的表情包功能借鉴了其优秀的设计，并且 Artalk 原生适配和兼容 OwO 格式的表情包数据文件，示例如下：
-
-```yaml
-frontend:
-  emoticons: https://raw.githubusercontent.com/DIYgod/OwO/master/demo/OwO.json
-  # 直接使用 OwO 格式的表情包 ↑↑
-```
-
-社区也有许多可以直接使用的 OwO 格式表情包资源，例如：[@2X-ercha/Twikoo-Magic](https://github.com/2X-ercha/Twikoo-Magic)。
-
-### Artalk 表情包列表文件标准格式
-
-Artalk 除了支持 OwO 格式外，还内置支持一种标准的表情包列表文件格式：
-
-```js
-[
-  {
-    name: '颜表情',
-    type: 'emoticon', // 字符类型
-    items: [
-      { key: 'Hi', val: '|´・ω・)ノ' },
-      { key: '开心', val: 'ヾ(≧∇≦*)ゝ' },
-      //...
-    ],
-  },
-  {
-    name: '滑稽',
-    type: 'image', // 图片类型
-    items: [
-      {
-        key: '原味稽',
-        val: '<图片 URL>',
-      },
-      //...
-    ],
-  },
-]
-```
-
-## 前端配置
-
-
-在前端配置表情包列表，例如：
-
-```js
-Artalk.init({
-  // 默认表情包列表，动态引入 ↓↓
-  emoticons:
-    'https://raw.githubusercontent.com/ArtalkJS/Emoticons/master/grps/default.json',
-})
-```
-
-::: tip
-
-配置文件和控制中心的表情包设置优先级高于前端配置。
-
-:::
-
-## 关闭表情包
-
-你可以将 `emoticons` 设置为 `false` 来禁用表情包功能：
-
-```js
-Artalk.init({
-  emoticons: false,
-})
-```
-
-## 加载方式
-
-### 动态加载
-
-将 `emoticons` 属性设置为表情包数据文件的 URL，当打开表情包列表时，Artalk 会动态引入。
-
-```js
-Artalk.init({
-  emoticons: '<表情包数据文件 URL>',
-})
-```
-
-远程的表情包文件支持 Artalk、OwO 格式，且支持嵌套、混合加载。
-
-### 静态加载
-
-相较于动态引入，可以将表情包列表对象，作为 Artalk 配置，静态保存在页面的 JS 代码中，避免动态加载：
-
-```js
-Artalk.init({
-  emoticons: [
-    {
-      name: '颜表情',
-      type: 'emoticon', // 字符类型
-      items: [
-        { key: 'Hi', val: '|´・ω・)ノ' },
-        { key: '开心', val: 'ヾ(≧∇≦*)ゝ' },
-        //...
-      ],
-    },
-    {
-      name: '滑稽',
-      type: 'image', // 图片类型
-      items: [
-        {
-          key: '原味稽',
-          val: '<图片 URL>',
-        },
-        //...
-      ],
-    },
-  ],
-})
-```
-
-### 混合加载
-
-Artalk 支持 **动态**、**静态** 混合加载，例如：
-
-```js
-Artalk.init({
-  emoticons: [
-    // 动态加载
-    'https://raw.githubusercontent.com/DIYgod/OwO/master/demo/OwO.json', // OwO 格式表情包
-    'https://raw.githubusercontent.com/qwqcode/huaji/master/huaji.json',
-    // 静态加载
-    {
-      name: '表情包名字',
-      type: 'emoticon', // 字符类型
-      items: [
-        { key: '去吧大师球', val: '(╯°A°)╯︵○○○' },
-        //...
-      ],
-    },
-  ],
-})
-```
-
-### 嵌套引入
-
-Artalk 支持远程表情包资源中**嵌套引入**另外的表情包资源，例如：
-
-```js
-Artalk.init({
-  emoticons: ['https://example.org/表情包.json'],
-})
-```
-
-文件 `表情包.json` 中的数据：
-
-```json
-[
-  "https://example.org/其他表情包.json",
-  //...
-  {
-    // Artalk 格式、OwO 格式
-    //...
-  }
-]
-```

docs/docs/guide/frontend/i18n.md

@@ -1,70 +0,0 @@
-# 多语言
-
-你可以在 Artalk 控制中心的设置页面选择语言，或通过环境变量 `ATK_LOCALE` 和配置文件 `artalk.yml` 的 `locale` 配置项设置 Artalk 的语言。
-
-```yml
-locale: zh-CN
-```
-
-`locale` 配置项格式遵循 [Unicode BCP 47](https://www.techonthenet.com/js/language_tags.php) 规范，默认为 "zh-CN" (简体中文)。
-
----
-
-目前 Artalk 支持语言如下：
-
-- "en" (English)
-- "zh-CN" (简体中文)
-- "zh-TW" (繁体中文)
-- "ja" (日本語)
-- "ko" (한국어)
-- "fr" (Français)
-- "ru" (Русский)
-
-## 贡献翻译
-
-欢迎提交 PR 帮助翻译 Artalk 的多语言，为社区贡献一份力量！
-
-| 翻译内容 | 语言文件目录                                                                                       | 模板文件                                                                                                 |
-| -------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
-| 后端程序 | [/i18n/[LANG].yml](https://github.com/ArtalkJS/Artalk/tree/master/i18n)                            | [zh-CN.yml](https://github.com/ArtalkJS/Artalk/blob/master/i18n/zh-CN.yml)                               |
-| 前端界面 | [/ui/artalk/src/i18n/[LANG].ts](https://github.com/ArtalkJS/Artalk/tree/master/ui/artalk/src/i18n) | [zh-CN.ts](https://github.com/ArtalkJS/Artalk/blob/master/ui/artalk/src/i18n/zh-CN.ts)                   |
-| 后台界面 | [/ui/artalk-sidebar/src/i18n/[LANG].ts](https://github.com/ArtalkJS/Artalk/blob/master/ui/artalk-sidebar/src/i18n) | [zh-CN.ts](https://github.com/ArtalkJS/Artalk/blob/master/ui/artalk-sidebar/src/i18n/zh-CN.ts) |
-| 配置文件 | [/conf/artalk.example.[LANG].yml](https://github.com/ArtalkJS/Artalk/tree/master/conf)             | [artalk.example.zh-CN.yml](https://github.com/ArtalkJS/Artalk/blob/master/conf/artalk.example.zh-CN.yml) |
-| 说明文档 | [/docs/[LANG]/\*\*/\*.md](https://github.com/ArtalkJS/Artalk/tree/master/docs)                      | [/docs/\*\*/\*.md](https://github.com/ArtalkJS/Artalk/tree/master/docs)                                   |
-
-更多参考：[开发文档](../../develop/index.md) / [CONTRIBUTING.md](https://github.com/ArtalkJS/Artalk/blob/master/CONTRIBUTING.md#translation)
-
-## 进阶配置
-
-### 前端临时修改语言
-
-前端会默认使用后端的语言配置，但你也可以在前端修改配置项 `locale` 来设定语言：
-
-```js
-Artalk.init({
-  locale: 'en-US',
-})
-```
-
-### 前端语言自动切换
-
-可将前端 locale 配置为 `"auto"`，根据用户浏览器自动切换语言，当语言不存在时，将被设置为 "en-US"。
-
-```js
-Artalk.init({
-  locale: 'auto',
-})
-```
-
-### 前端自定义 locale 内容
-
-在前端可传入 Object 类型，按照 [模板文件](https://github.com/ArtalkJS/Artalk/blob/master/ui/artalk/src/i18n/zh-CN.ts) 中的 Keys 编写自定义 locale 内容。
-
-```js
-Artalk.init({
-  locale: {
-    email: 'Eメール',
-    //...
-  },
-})
-```

docs/docs/guide/frontend/img-lazy-load.md

@@ -1,53 +0,0 @@
-# 图片懒加载
-
-Artalk 支持为评论中的图片添加懒加载功能，以减少页面加载时间。该功能默认禁用，可在控制中心「设置 - 界面配置」找到「图片懒加载」配置项 (frontend.imgLazyLoad)：
-
-| 配置值 | 说明 |
-| --- | --- |
-| `native` | 使用浏览器原生的图片懒加载 |
-| `data-src` | 使用懒加载库实现图片懒加载 |
-| `false` | 禁用图片懒加载 |
-
-## 浏览器原生
-
-当图片懒加载设置为 `native` 时，Artalk 将使用浏览器原生的图片懒加载功能，即为图片标签添加 `loading="lazy"` 属性。例如：
-
-```html
-<img src="1.png" loading="lazy" />
-```
-
-这不需要额外引入库和编写代码，是最简单的方式，但部分浏览器可能不支持该属性，或者实现的懒加载策略不同，详情参考：[MDN - 懒加载](https://developer.mozilla.org/zh-CN/docs/Web/Performance/Lazy_loading)。
-
-## 懒加载库
-
-使用该方式能确保在不同的浏览器下有一致的表现，并且能定制更多功能，如图片加载动画等。一个博客主题可能自带懒加载库，借助其附带的库，让 Artalk 也同时支持懒加载。
-
-当图片懒加载设置为 `data-src` 时，Artalk 将为图片标签添加 `class="lazyload"` 和 `data-src` 属性。例如：
-
-```html
-<img data-src="1.png" class="lazyload" />
-```
-
-这时，你需要引入一个额外的图片懒加载库：[vanilla-lazyload](https://github.com/verlok/vanilla-lazyload)；在页面的 `<head>` 中添加以下代码：
-
-```html
-<script src="https://unpkg.com/vanilla-lazyload/dist/lazyload.iife.min.js"></script>
-```
-
-编写代码，在 Artalk 初始化之前，添加事件监听：当评论列表发生更新后，调用图片懒加载库的 `update` 方法：
-
-```js
-// 初始化图片懒加载库
-const lazyLoadInstance = new LazyLoad({
-  elements_selector: '.lazyload',
-  threshold: 0,
-})
-
-// 监听 Artalk 事件
-Artalk.use((ctx) => {
-  ctx.on('list-loaded', () => lazyLoadInstance.update())
-})
-
-// 初始化 Artalk
-const artalk = Artalk.init({ /* ... */ })
-```

docs/docs/guide/frontend/import-blog.md

@@ -1,7 +0,0 @@
-# 置入博客
-
-本页面内容已移动至 <https://artalk.js.org/develop/import-blog.html>。
-
-<script setup lang="ts">
-if (!import.meta.env.SSR) window.location = 'https://artalk.js.org/develop/import-blog.html';
-</script>

docs/docs/guide/frontend/import-framework.md

@@ -1,7 +0,0 @@
-# 置入框架
-
-本页面内容已移动至 <https://artalk.js.org/develop/import-framework.html>。
-
-<script setup lang="ts">
-if (!import.meta.env.SSR) window.location = 'https://artalk.js.org/develop/import-framework.html';
-</script>

docs/docs/guide/frontend/install.md

@@ -1,7 +0,0 @@
-# 前端部署
-
-本页面内容已移动至 <https://artalk.js.org/guide/deploy.html>。
-
-<script setup lang="ts">
-if (!import.meta.env.SSR) window.location = 'https://artalk.js.org/guide/deploy.html';
-</script>

docs/docs/guide/frontend/ip-region.md

@@ -1,46 +0,0 @@
-# IP 属地
-
-Artalk 内置用户 IP 属地展示功能，并且你可以设置显示的精度：精确到市、省。
-
-该功能默认关闭，你可在 Artalk 控制中心设置中启用 IP 属地展示功能。
-
-## IP 属地数据库
-
-在开启 IP 属地展示功能之前，你需要下载一个数据库文件：
-
-- [GitHub 下载](https://github.com/lionsoul2014/ip2region/raw/master/data/ip2region.xdb) / [镜像站下载](https://gh-proxy.com/?q=https%3A%2F%2Fgithub.com%2Flionsoul2014%2Fip2region%2Fblob%2Fmaster%2Fdata%2Fip2region.xdb) (境内推荐)
-
-下载后请手动放置到 `./data/` 目录下，文件命名为：`ip2region.xdb`
-
-## 精度设置
-
-你可在设置中找到该配置项。
-
-| 显示精度   | 描述             | 示例       |
-| ---------- | ---------------- | ---------- |
-| `province` | 精确到省（默认） | `四川`     |
-| `city`     | 精确到城市       | `四川成都` |
-| `country`  | 精确到国家、地区 | `中国`     |
-
-配置文件：
-
-```yaml
-# IP 属地
-ip_region:
-  # 启用 IP 属地展示
-  enabled: false
-  # 数据文件路径 (.xdb 格式)
-  db_path: ./data/ip2region.xdb
-  # 显示精度 ["province", "city", "country"]
-  precision: province
-```
-
-## 获取准确的 IP 地址
-
-如果你正在使用 CDN 或者 Nginx 等可信的反向代理服务器，那么你需要在「设置」-「服务器」选项 -「代理标头名 (`http.proxy_header`)」填写包含用户真实 IP 的请求头字段名，如：`X-Real-IP`（为了安全，该字段默认为空）。修改后，请手动重启 Artalk 服务以生效。
-
-否则 Artalk 将无法获取到用户真实 IP 地址（如果使用了 Docker，可能获取到的 IP 始终是 172.17.0.X，这是 Docker 虚拟网卡的 IP）。
-
-## 隐私权
-
-Artalk 评论将记录用户的 `IP` 和 `User-Agent` 数据，此类数据有关用户隐私权，请在你的网站隐私政策中声明，并提示用户评论将会收集隐私数据。

docs/docs/guide/frontend/latex.md

@@ -1,41 +0,0 @@
-# LaTeX
-
-对于学术网站来说，支持 LaTeX 是一个刚需，可以使用 [Katex](https://katex.org/) 这款被前端广泛使用的 LaTeX 语法解析器来继承该功能。Artalk 为保持简洁，并未内置 LaTeX 语法解析功能，你可以手动在页面中引入 Katex 和 Artalk Katex 插件，让评论系统获得 LaTeX 语法支持。
-
-::: code-group
-
-```html [浏览器引入]
-<!-- 1. 引入 Katex -->
-<link rel="stylesheet" href="https://unpkg.com/katex@0.16.7/dist/katex.min.css" />
-<script src="https://unpkg.com/katex@0.16.7/dist/katex.min.js"></script>
-
-<!-- 2. 引入 Artalk -->
-<link href="/lib/artalk/Artalk.css" rel="stylesheet" />
-<script src="/lib/artalk/Artalk.js"></script>
-
-<!-- 3. 引入 Artalk Katex 插件 -->
-<script src="https://unpkg.com/@artalk/plugin-katex/dist/artalk-plugin-katex.js"></script>
-```
-
-```ts [Node 引入]
-// pnpm add katex @artalk/plugin-katex
-import Artalk from 'artalk'
-import { ArtalkKatexPlugin } from '@artalk/plugin-katex'
-import 'katex/dist/katex.min.css'
-
-Artalk.use(ArtalkKatexPlugin)
-```
-
-:::
-
-你可以发表评论：
-
-```md
-$$
-P(A|B_1, B_2, \ldots, B_n) = \frac{P(B_1, B_2, \ldots, B_n|A) \cdot P(A)}{P(B_1, B_2, \ldots, B_n)}
-$$
-```
-
-检验效果：
-
-![](/images/latex-support/1.png)

docs/docs/guide/frontend/lightbox.md

@@ -1,121 +0,0 @@
-# 图片灯箱
-
-Artalk 图片灯箱插件帮助你将网站**现有的图片灯箱**功能自动集成到 Artalk 中。
-
-## 浏览器环境
-
-如果处于浏览器环境，博客主题通常自带图片灯箱，插件将自动检测 `window` 全局对象中的灯箱库，并集成到 Artalk 中，无需额外配置。
-
-```html
-<!-- 1. 引入图片灯箱依赖，例如 LightGallery (通常博客主题已提供，无需再引入) -->
-<script src="lightgallery.js"></script>
-
-<!-- 2. 引入 Artalk -->
-<link href="/lib/artalk/Artalk.css" rel="stylesheet" />
-<script src="/lib/artalk/Artalk.js"></script>
-
-<!-- 3. 引入 Artalk LightBox 插件 -->
-<script src="https://unpkg.com/@artalk/plugin-lightbox/dist/artalk-plugin-lightbox.js"></script>
-```
-
-如有需要，可以通过全局变量 `ATK_LIGHTBOX_CONF` 对灯箱库进行额外的配置：
-
-```html
-<script>
-// Config for LightGallery
-window.ATK_LIGHTBOX_CONF = {
-  plugins: [lgZoom, lgThumbnail],
-  speed: 500,
-  licenseKey: 'your_license_key'
-}
-</script>
-```
-
-## Node 环境
-
-安装图片灯箱插件：
-
-```bash
-pnpm add @artalk/plugin-lightbox
-```
-
-配置插件，通过 `import` 动态引入灯箱库：
-
-::: code-group
-
-```ts [LightGallery]
-import Artalk from 'artalk'
-import { ArtalkLightboxPlugin } from '@artalk/plugin-lightbox'
-import 'lightgallery/css/lightgallery.css'
-
-Artalk.use(ArtalkLightboxPlugin, {
-  lightGallery: {
-    lib: () => import('lightgallery'),
-  },
-})
-```
-
-```ts [PhotoSwipe]
-import Artalk from 'artalk'
-import { ArtalkLightboxPlugin } from '@artalk/plugin-lightbox'
-import 'photoswipe/style.css'
-
-Artalk.use(ArtalkLightboxPlugin, {
-  photoSwipe: {
-    lib: () => import('photoswipe/lightbox'),
-    pswpModule: () => import('photoswipe'),
-  },
-})
-```
-
-```ts [LightBox]
-import Artalk from 'artalk'
-import { ArtalkLightboxPlugin } from '@artalk/plugin-lightbox'
-import 'lightbox2/dist/css/lightbox.min.css'
-import jQuery from 'jquery'
-
-window.$ = jQuery
-
-Artalk.use(ArtalkLightboxPlugin, {
-  lightBox: {
-    // @ts-ignore
-    lib: () => import('lightbox2'),
-  },
-})
-```
-
-```ts [FancyBox]
-import Artalk from 'artalk'
-import { ArtalkLightboxPlugin } from '@artalk/plugin-lightbox'
-import 'fancybox/dist/css/jquery.fancybox.css'
-import jQuery from 'jquery'
-
-window.$ = jQuery
-
-Artalk.use(ArtalkLightboxPlugin, {
-  fancyBox: {
-    // @ts-ignore
-    lib: () => import('fancybox'),
-  },
-})
-```
-
-:::
-
-在 Node 环境中，如有需要对灯箱库进行额外的配置，可以通过 `config` 选项配置：
-
-```ts
-Artalk.use(ArtalkLightboxPlugin, {
-  // ...
-  // Config for LightGallery
-  config: {
-    speed: 500,
-  },
-})
-```
-
----
-
-目前自动集成支持：[LightGallery](https://github.com/sachinchoolur/lightGallery) • [FancyBox](https://github.com/fancyapps/fancybox) • [lightbox2](https://github.com/lokesh/lightbox2) • [PhotoSwipe](https://photoswipe.com/)
-
-一些灯箱库暂未适配，期待你的 PR 😉：[@artalk/plugin-lightbox](https://github.com/ArtalkJS/Artalk/blob/master/ui/plugin-lightbox/src/main.ts)。

docs/docs/guide/frontend/pv.md

@@ -1,81 +0,0 @@
-# 浏览量统计
-
-Artalk 内置页面浏览量统计和评论数统计功能，你可以在页面中显示页面的浏览量和评论数。
-
-```html
-浏览量：<span class="artalk-pv-count"></span>
-评论数：<span class="artalk-comment-count"></span>
-```
-
-## 加载占位符
-
-Artalk 加载需要时间，你可以在展示统计数的元素中加入占位符：
-
-```html
-<span class="artalk-pv-count">加载中...</span>
-```
-
-## 同时加载多个页面的统计数
-
-例如在文章列表页，你可以显示每篇文章的浏览量和评论数。
-
-当处于文章列表页时，仅需调用 `Artalk.loadCountWidget` 函数，而无需 `Artalk.init` (加载评论列表会使页面浏览量 PV 数 +1)。
-
-<!-- prettier-ignore-start -->
-
-```js
-Artalk.loadCountWidget({
-  server: '服务器地址',
-  site: '站点名',
-  pvEl: '.artalk-pv-count',
-  countEl: '.artalk-comment-count',
-  statPageKeyAttr: 'data-page-key',
-})
-```
-
-<!-- prettier-ignore-end -->
-
-然后放置多个 class 为 `artalk-pv-count` 的元素，通过属性 `data-page-key` 来指定需要查询的页面：
-
-```html
-<span class="artalk-pv-count" data-page-key="/test/1.html"></span>
-<span class="artalk-pv-count" data-page-key="/test/2.html"></span>
-<span class="artalk-pv-count" data-page-key="/test/3.html"></span>
-```
-
-评论数查询同理：
-
-```html
-<span class="artalk-comment-count" data-page-key="/test/1.html"></span>
-<span class="artalk-comment-count" data-page-key="/test/2.html"></span>
-<span class="artalk-comment-count" data-page-key="/test/3.html"></span>
-```
-
-## 自定义元素选择器
-
-可通过配置项 `pvEl` 和 `countEl` 来指定元素选择器，以展示页面浏览量和评论数：
-
-```js
-Artalk.init({
-  pvEl: '.your_pv_count_element',  // 页面浏览量元素选择器
-  countEl: '.your_comment_count_element',  // 评论数元素选择器
-})
-```
-
-## 自定义 `data-page-key` 属性名
-
-配置项 `statPageKeyAttr` 的默认值为 `data-page-key`，Artalk 会通过该属性名来查询指定页面。为了方便博客主题的适配，可通过它自定义属性名，例如将其替换为 `data-path`：
-
-```js
-Artalk.loadCountWidget({
-  statPageKeyAttr: 'data-path',
-})
-```
-
-此时，对应的 HTML 代码应如下所示：
-
-```html
-<span class="artalk-pv-count" data-path="/test/1.html"></span>
-```
-
-这样，`data-path` 属性值将被用于查询指定的页面。

docs/docs/guide/frontend/sidebar.md

@@ -1,45 +0,0 @@
-# 侧边栏
-
-侧边栏同时充当 **通知中心** + **控制中心** 的功能，当用户填写评论框的“**昵称**”和“**邮箱**”后，侧边栏入口按钮能在评论框右下角找到。
-
-<img src="/images/sidebar/1.png" width="650">
-
-## 通知中心
-
-Artalk 拥有站内消息功能，在接收邮件通知的同时，也能在侧边栏查看消息。
-
-在侧边栏可以查看与自己相关的评论，分类包括：提及、全部、我的、待审。
-
-你能快速找到评论，并跳转到对应页面。
-
-<img src="/images/sidebar/2.png" width="430">
-
-当用户收到消息时，会显示红点标记。
-
-<img src="/images/sidebar/3.png" width="350">
-
-另外，你能在侧边栏快速回复对方的消息，无需切换到评论页面。
-
-<img src="/images/sidebar/4.png" width="400">
-
-## 控制中心
-
-管理员账户侧边栏将自动从“通知中心”升级为“控制中心”。
-
-管理员输入“昵称”和“邮箱”后，将弹出密码验证提示框：
-
-<img src="/images/sidebar/5.png" width="600">
-
-进入侧边栏，你可以对评论、页面、站点等内容进行管理操作。
-
-<img src="/images/sidebar/6.png" width="800">
-
-点击左上角的站点图标，你能在多个站点之间快速切换。
-
-<img src="/images/sidebar/7.png" width="400">
-
-## 设置
-
-登录管理员账户进入“控制中心”的设置界面，可修改 [配置](/guide/backend/config.md) 和 [界面](/guide/frontend/config.md)，无需编辑复杂的配置文件。
-
-<img src="/images/sidebar/settings.png" width="700">