chore: release v2.7.2

* docs: rebuild docs

* chore: fix eslint

* ci: add docs build test

* update test-docs.yml

* fix script

* add netlify.toml

* fix docs:patch

---------

Co-authored-by: qwqcode <qwqcode@gmail.com>

.circleci/conditional_config.yml

@@ -2,6 +2,7 @@ version: 2.1
 
 orbs:
   node: circleci/node@5.0.3
+  codecov: codecov/codecov@3.3.0
 
 executors:
   base:
@@ -9,18 +10,15 @@ executors:
       - image: cimg/base:stable
   node:
     docker:
-      - image: 'cimg/node:18.17.1'
+      - image: 'cimg/node:18.19.0'
   go:
     docker:
-      - image: cimg/go:1.21.0
+      - image: cimg/go:1.21.3
 
 parameters:
   trigger-app:
     type: boolean
     default: false
-  trigger-ui:
-    type: boolean
-    default: false
   run-them-all:
     type: boolean
     default: false
@@ -40,40 +38,24 @@ jobs:
               go version
         - restore_cache:
             keys:
-              - go-mod-1.21.0-{{ checksum "go.sum" }}
+              - go-mod-1.21.3-{{ checksum "go.sum" }}
         - run:
             name: Install Dependencies
             command: go mod download
         - save_cache:
-            key: go-mod-1.21.0-{{ checksum "go.sum" }}
+            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
+              gotestsum --junitfile /tmp/test-reports/unit-tests.xml -- -coverprofile=/tmp/test-reports/coverage.out ./...
         - store_test_results:
             path: /tmp/test-reports
-
-  ## Frontend
-  test_ui:
-      executor: node
-      steps:
-        - node/install
-        - checkout
-        - run:
-            name: Print the node version
-            command: node -v
-        - run:
-            name: Install pnpm
-            command: npm i -g pnpm@8.7.0
-        - run:
-            name: Install Dependencies
-            command: pnpm --dir ./ui install --frozen-lockfile
-        - run:
-            name: Build Artalk
-            command: pnpm --dir ./ui build:all
+        - codecov/upload:
+            flags: go
+            file: /tmp/test-reports/coverage.out
 
   all_projects:
       executor: base
@@ -91,14 +73,6 @@ workflows:
     jobs:
       - test_app
 
-  build-ui:
-    when:
-      or:
-        - << pipeline.parameters.trigger-ui >>
-        - << pipeline.parameters.run-them-all >>
-    jobs:
-      - test_ui
-
   build-shared-other:
     when: << pipeline.parameters.run-them-all >>
     jobs:

.circleci/config.yml

@@ -17,7 +17,6 @@ workflows:
           mapping: |
             (cmd|internal|server|pkg|test|conf)/.*  trigger-app true
             main.go|go.mod|go.sum  trigger-app true
-            (ui)/.*  trigger-ui  true
           base-revision: master  # git branch name
           config-path: .circleci/conditional_config.yml
           filters:

.github/workflows/build-app.yml

@@ -6,7 +6,7 @@ on:
     types: [artalk-release]
 
 env:
-  GO_VERSION: '1.21.0'
+  GO_VERSION: '1.21.3'
   PKG_NAME: 'github.com/ArtalkJS/Artalk'
   DOCKER_IMG: ghcr.io/goreleaser/goreleaser-cross
   CACHE_DIR: /tmp/cache/docker-image

.github/workflows/docs-cn.yml

@@ -13,50 +13,32 @@ jobs:
 
     runs-on: ubuntu-latest
 
-    defaults:
-      run:
-        # set for building docs
-        working-directory: ./docs
-
     steps:
-    # - 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: Checkout
+        uses: actions/checkout@v3
 
-    - name: Checkout
-      uses: actions/checkout@v3
+      - name: Use pnpm
+        uses: pnpm/action-setup@v2
 
-    - name: Use pnpm
-      uses: pnpm/action-setup@v2
-      with:
-        version: 8
+      - name: Setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: "pnpm"
 
-    - name: Setup node
-      uses: actions/setup-node@v3
-      with:
-        node-version: 18.x
-        registry-url: https://registry.npmjs.org/
-        cache: 'pnpm'
+      - name: Install dependencies
+        run: pnpm install
 
-    - name: Install dependencies
-      run: pnpm install
+      - name: Build Docs
+        run: pnpm docs:build
 
-    - 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
+      - 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/test-docs.yml

@@ -0,0 +1,32 @@
+name: Test Docs
+
+on:
+  pull_request:
+    paths:
+      - "docs/**"
+  push:
+    paths:
+      - "docs/**"
+
+jobs:
+  test_docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Use pnpm
+        uses: pnpm/action-setup@v2
+
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18.x
+          cache: pnpm
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Build Docs
+        run: pnpm docs:build

.github/workflows/test-frontend.yml

@@ -0,0 +1,47 @@
+name: Test Frontend
+
+on:
+  push:
+    paths:
+      - 'ui/**'
+  pull_request:
+    paths:
+      - 'ui/**'
+
+jobs:
+  test_ui:
+    strategy:
+      matrix:
+        node: [18, 20]
+        os: [ubuntu-latest, windows-latest]
+
+    runs-on: ${{ matrix.os }}
+
+    defaults:
+      run:
+        working-directory: ./ui
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v3
+
+      - uses: pnpm/action-setup@v2
+        with:
+          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 --dir ./ui install --frozen-lockfile
+
+      - name: Package Build Test
+        run: pnpm build:all
+
+      # TODO: Add unit test
+      # - name: Unit test
+      #   run: pnpm test

.gitignore

@@ -65,3 +65,6 @@ node_modules
 # always compile latest version
 /public/sidebar
 /public/dist
+
+playwright-report
+test-results

.vscode/settings.json

@@ -1,4 +1,5 @@
 {
+    "eslint.workingDirectories": ["./ui"],
     "cSpell.words": [
         "akismet",
         "artalk",
@@ -16,4 +17,4 @@
         "sqlite",
         "pkged"
     ]
-}
+}

CHANGELOG.md

@@ -1,4 +1,136 @@
 
+## [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
+
+* **build:** generate source maps to ease debugging
+* **cout-widget:** `loadCountWidget` issue
+* **ui:** static method export issue in JS module ([#669](https://github.com/ArtalkJS/Artalk/issues/669))
+
+### Documentation
+
+* **i18n:** add translation of update notice
+
+
+## [v2.7.0](https://github.com/ArtalkJS/Artalk/compare/v2.6.4...v2.7.0) (2023-12-17)
+
+### Features
+
+* **ui:** support `scrollRelativeTo` config option
+* **ui/test:** add end-to-end (e2e) testing using Playwright
+
+### Bug Fixes
+
+* **api/img-upload:** `public_path` config enables the use of full url ([#659](https://github.com/ArtalkJS/Artalk/issues/659)) ([#664](https://github.com/ArtalkJS/Artalk/issues/664))
+* **lifecycle:** create multi-instances at the same time ([#660](https://github.com/ArtalkJS/Artalk/issues/660)) ([#663](https://github.com/ArtalkJS/Artalk/issues/663))
+* **notify_pusher:** panic when admin ids array is empty ([#634](https://github.com/ArtalkJS/Artalk/issues/634))
+* **style/list:** replace `float` to `text-align` in footer part ([#619](https://github.com/ArtalkJS/Artalk/issues/619))
+* **ui:** scroll to the center of the viewport issue
+* **ui/conf:** sanitize `noComment` conf option for security ([#624](https://github.com/ArtalkJS/Artalk/issues/624))
+* **ui/dark-mode:** `setDarkMode` cannot save to instance config ([#661](https://github.com/ArtalkJS/Artalk/issues/661))
+* **ui/editor:** fix position of the comment box when replying ([#643](https://github.com/ArtalkJS/Artalk/issues/643)) ([#648](https://github.com/ArtalkJS/Artalk/issues/648))
+
+### Performance Improvements
+
+* **cache:** implement GC feature for simple_cache pkg ([#656](https://github.com/ArtalkJS/Artalk/issues/656))
+
+### Code Refactoring
+
+* **editor:** refactor editor plugin manager ([#609](https://github.com/ArtalkJS/Artalk/issues/609))
+* **editor:** refactor plug kit and events ([#613](https://github.com/ArtalkJS/Artalk/issues/613))
+* **ui:** reduce coupling with `ContextApi`
+* **ui:** separate standalone admin-only-elem checker
+* **ui/api:** loose coupling between `Api` and `Context`
+* **ui/conf:** loose coupling between config and list fetch
+* **ui/event:** refactor core event manager ([#611](https://github.com/ArtalkJS/Artalk/issues/611))
+* **ui/layer:** better layer implements and independence ([#662](https://github.com/ArtalkJS/Artalk/issues/662))
+* **ui/list:** separate list into standalone components ([#618](https://github.com/ArtalkJS/Artalk/issues/618))
+* **ui/marked:** separate markdown related codes
+* **ui/marked:** loose coupling with `marked` func
+* **ui/plugin:** further divide functionality into plugins ([#615](https://github.com/ArtalkJS/Artalk/issues/615))
+* **ui/stat:** losing coupling of `CountWidget`
+* **ui/types:** better `ArtalkType` import and export ([#620](https://github.com/ArtalkJS/Artalk/issues/620))
+
+### Documentation
+
+* revise and add more examples
+* provide clearer and more detailed instructions in CONTRIBUTING.md
+* **conf:** disable `frontend.uaBadge` config option by default
+* **deploy:** add deployment guide for render.com ([#649](https://github.com/ArtalkJS/Artalk/issues/649))
+* **import:** update the examples in import-framework.md ([#665](https://github.com/ArtalkJS/Artalk/issues/665))
+
+### BREAKING CHANGE
+
+
+The following top-level functions exported by the 'artalk' npm package have been deprecated: `Artalk.update`, `Artalk.reload`, and `Artalk.destroy`. These methods now require invocation on an instance created by either `Artalk.init` or `new Artalk`. Please utilize instance-level methods instead, such as `artalkInstance.update`. For more information, refer to  [the documentation](https://artalk.js.org/guide/frontend/import-framework.html). The update was implemented to enable the concurrent creation of multiple instances, adapting to situations where Vue components are simultaneously referenced across various pages. Initially, only a singular instance was permitted to mitigate memory leak concerns. However, this proved limiting for scenarios involving the caching of multiple component instances through 'keep-alive.' To better suit intricate SPA application needs, the choice was made to permit the creation of multiple independent instances. It's crucial to remember to manually invoke the `artalk.destroy` method when releasing components to avoid memory leaks (Issue [#660](https://github.com/ArtalkJS/Artalk/issues/660)).
+
+
+## [v2.6.4](https://github.com/ArtalkJS/Artalk/compare/v2.6.3...v2.6.4) (2023-10-12)
+
+### Features
+
+* **go:** upgrade golang to v1.21.3 and some deps
+
+### Bug Fixes
+
+* **editor:** fix duplicate event binding when update conf ([#605](https://github.com/ArtalkJS/Artalk/issues/605))
+* **email:** sender not initialized correctly
+* **style:** fix copyright text overlay on send button ([#607](https://github.com/ArtalkJS/Artalk/issues/607))
+
+### Code Refactoring
+
+* **anti_spam:** refactor anti_spam pkg and add unit test ([#589](https://github.com/ArtalkJS/Artalk/issues/589))
+
+
+## [v2.6.3](https://github.com/ArtalkJS/Artalk/compare/v2.6.2...v2.6.3) (2023-09-20)
+
+### Features
+
+* **config:** add `db.ssl` to enable db ssl mode ([#587](https://github.com/ArtalkJS/Artalk/issues/587))
+
+### Bug Fixes
+
+* **notify_tpl:** fix template render result in notify case
+
+### Performance Improvements
+
+* **config:** add error message for timezone setting ([#586](https://github.com/ArtalkJS/Artalk/issues/586))
+
+### Code Refactoring
+
+* **renderer:** abstract func of template renderer for multi-cases ([#585](https://github.com/ArtalkJS/Artalk/issues/585))
+
+### Documentation
+
+* new landing page
+
+
 ## [v2.6.2](https://github.com/ArtalkJS/Artalk/compare/v2.6.1...v2.6.2) (2023-09-12)
 
 ### Bug Fixes

CODE_OF_CONDUCT.md

@@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
 Examples of behavior that contributes to a positive environment for our
 community include:
 
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
   and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall
+- Focusing on what is best not just for us as individuals, but for the overall
   community
 
 Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery, and sexual attention or advances of
+- The use of sexualized language or imagery, and sexual attention or advances of
   any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email address,
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address,
   without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ## Enforcement Responsibilities
@@ -59,7 +59,7 @@ representative at an online or offline event.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at artalkjs@gmail.com.
+reported to the community leaders responsible for enforcement at <artalkjs@gmail.com>.
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

CONTRIBUTING.md

@@ -6,7 +6,7 @@ This guide is for developers who want to contribute to the project.
 
 To develop Artalk, including the frontend and backend, you need to install the following tools:
 
-- [Node.js](https://nodejs.org/en/) (>= 16.0.0)
+- [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)
@@ -29,22 +29,41 @@ Enter the directory:
 cd Artalk
 ```
 
-### Build frontend and backend
+### Build Backend
 
-First, we need to install the dependencies for backend written in Go. Simply run the following command:
+First, you need to install the dependencies for the backend written in Go. Simply run the `make install` command to install the dependencies.
 
-```sh
-make build-debug
-```
+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`.
 
-This will build both the frontend and backend, with debugging symbols.
+This will build the backend with debugging symbols. The binary file will be placed under the `./bin` directory.
 
-- **Frontend** will be built under `./ui/packages/artalk` and copied to `./public` directory.
-- **Backend** will be built under `./bin` directory.
+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.
 
-### Optional: Use one-key script to run a demo site
+### Build Frontend
 
-If you want to run a demo site, you can use 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
 ./scripts/setup-example-site.sh
@@ -70,6 +89,14 @@ email: "admin@test.com"
 password: "admin"
 ```
 
+## Testing
+
+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.
+
+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.
+
 ## Project Structure
 
 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.

Dockerfile

@@ -1,12 +1,12 @@
 ### build Artalk
-FROM golang:1.21.0-alpine3.18 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 nodejs bash npm\
-    && npm install -g pnpm@8.7.0
+    && npm install -g pnpm@8.12.1
 
 # download go deps
 # (cache by separating the downloading of deps)

Makefile

@@ -52,6 +52,7 @@ update-i18n:
 	go generate ./internal/i18n
 
 update-swagger:
+	go install github.com/swaggo/swag/cmd/swag@latest
 	swag init -g server/server.go --output ./docs/swagger
 
 docker-build:
@@ -60,6 +61,9 @@ docker-build:
 docker-push:
 	./scripts/docker-build.sh --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;
+	docker-build docker-push test-frontend-e2e;

README.en.md

@@ -4,12 +4,12 @@
 
 # Artalk
 
-[![](https://img.shields.io/npm/v/artalk.svg?style=flat-square)](https://www.npmjs.com/package/artalk)
-[![](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)
+[![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)
 
-> 🌌 A Self-hosted comment system
+> 🌌 A self-hosted comment system
 
 [简体中文](./README.md) / [Documentation](https://artalk.js.org) / [Releases](https://github.com/ArtalkJS/Artalk/releases) / [Artalk](https://github.com/ArtalkJS/Artalk)
 

README.md

@@ -4,11 +4,13 @@
 
 # Artalk
 
-[![](https://img.shields.io/npm/v/artalk.svg?style=flat-square)](https://www.npmjs.com/package/artalk)
-[![](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)
+[![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)
-[![CircleCI](https://circleci.com/gh/ArtalkJS/Artalk/tree/master.svg?style=svg)](https://circleci.com/gh/ArtalkJS/Artalk/tree/master)
+[![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)
 
 > 🌌 Golang 自托管评论系统
 
@@ -53,13 +55,19 @@
 - 支持 Latex：提供集成 Katex 插件
 - 使用 [Vite](https://github.com/vitejs/vite)：属于开发者的极致体验
 
-更多内容请查看：[“**介绍文档**”](https://artalk.js.org/guide/intro.html)
+更多内容请查看：[**介绍文档**](https://artalk.js.org/guide/intro.html)
 
-## 食用方针
+## 安装
 
-前往：[“**部署文档**”](https://artalk.js.org/guide/deploy.html)
+参考：[**部署文档**](https://artalk.js.org/guide/deploy.html)
+
+```bash
+npm install artalk
+```
 
 ```ts
+import Artalk from 'artalk'
+
 Artalk.init({
   el:     '#Comments',
   site:   'Artalk 的博客',
@@ -74,6 +82,7 @@ docker run -d \
   --name artalk \
   -p 8080:23366 \
   -v $(pwd)/data:/data \
+  --restart=always \
   artalk/artalk-go
 ```
 
@@ -89,6 +98,7 @@ services:
   artalk:
     container_name: artalk
     image: artalk/artalk-go
+    restart: always
     ports:
       - 8080:23366
     volumes:
@@ -119,7 +129,7 @@ see [CONTRIBUTING.md](./CONTRIBUTING.md)
 
 感谢社区提供的帮助与反馈，若有好的建议与意见欢迎前往 [ISSUES](https://github.com/ArtalkJS/Artalk/issues) 随时告知。
 
-## TODOs 
+## TODOs
 
 - [x] Golang 后端
 - [x] 多数据库支持

cmd/base.go

@@ -26,7 +26,7 @@ var Banner = `
 
 Artalk (` + Version + `)
 
- -> A Selfhosted Comment System.
+ -> A Self-hosted Comment System.
  -> https://artalk.js.org
 `
 
@@ -50,7 +50,7 @@ func New() *ArtalkCmd {
 	cmd := &ArtalkCmd{
 		RootCmd: &cobra.Command{
 			Use:     "artalk",
-			Short:   "Artalk: Your self-hosted comment system",
+			Short:   "Artalk: A self-hosted comment system",
 			Long:    Banner,
 			Version: Version,
 			Run: func(cmd *cobra.Command, args []string) {

conf/artalk.example.simple.yml

@@ -16,6 +16,7 @@ db:
   user: "root"
   password: ""
   charset: "utf8mb4"
+  ssl: false
 log:
   enabled: true
   filename: "./data/artalk.log"
@@ -35,7 +36,6 @@ ssl:
   enabled: false
   cert_path: ""
   key_path: ""
-admin_users:
 moderator:
   pending_default: false
   api_fail_block: false
@@ -53,7 +53,8 @@ moderator:
   keywords:
     enabled: false
     pending: false
-    files: []
+    files:
+      - "./data/keywords_1.txt"
     file_sep: "\n"
     replac_to: "x"
 captcha:
@@ -74,11 +75,21 @@ captcha:
   geetest:
     captcha_id: ""
     captcha_key: ""
+img_upload:
+  enabled: true
+  path: "./data/artalk-img/"
+  max_size: 5
+  public_path: null
+  upgit:
+    enabled: false
+    exec: "./upgit -c UPGIT_CONF_FILE_PATH -t /artalk-img"
+    del_local: true
 email:
   enabled: false
   send_type: "smtp"
   send_name: "{{reply_nick}}"
   send_addr: "noreply@example.com"
+  mail_subject: "[{{site_name}}] You got a reply from @{{reply_nick}}"
   mail_tpl: "default"
   smtp:
     host: "smtp.qq.com"
@@ -89,15 +100,6 @@ email:
     access_key_id: ""
     access_key_secret: ""
     account_name: "noreply@example.com"
-img_upload:
-  enabled: true
-  path: "./data/artalk-img/"
-  max_size: 5
-  public_path: null
-  upgit:
-    enabled: false
-    exec: "./upgit -c UPGIT_CONF_FILE_PATH -t /artalk-img"
-    del_local: true
 admin_notify:
   notify_tpl: "default"
   noise_mode: false
@@ -140,10 +142,10 @@ frontend:
   noComment: ""
   sendBtn: ""
   editorTravel: true
-  emoticons: ""
+  emoticons: "https://cdn.jsdelivr.net/gh/ArtalkJS/Emoticons/grps/default.json"
   vote: true
   voteDown: false
-  uaBadge: true
+  uaBadge: false
   listSort: true
   pvEl: "#ArtalkPV"
   countEl: "#ArtalkCount"
@@ -152,7 +154,7 @@ frontend:
   nestMax: 2
   nestSort: DATE_ASC
   gravatar:
-    mirror: "https://www.gravatar.com/"
+    mirror: "https://www.gravatar.com/avatar/"
     params: "d=mp&s=240"
   pagination:
     pageSize: 20

conf/artalk.example.yml

@@ -45,6 +45,8 @@ db:
   password: ""
   # Database charset
   charset: "utf8mb4"
+  # Enable SSL mode
+  ssl: false
 
 # Logging
 log:
@@ -282,7 +284,7 @@ frontend:
   # Dislike button
   voteDown: false
   # User UA badge
-  uaBadge: true
+  uaBadge: false
   # Comment sorting
   listSort: true
   # Page PV binding element

conf/artalk.example.zh-CN.yml

@@ -42,6 +42,8 @@ db:
   charset: "utf8mb4"
   # 表前缀 (例如："atk_")
   table_prefix: ""
+  # 启用 SSL
+  ssl: false
 
 # 日志
 log:
@@ -289,7 +291,7 @@ frontend:
   # 反对按钮
   voteDown: false
   # 用户 UA 徽标
-  uaBadge: true
+  uaBadge: false
   # 评论排序功能
   listSort: true
   # 页面 PV 绑定元素

docs/.npmrc

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

docs/.vitepress/config.ts

@@ -1,206 +0,0 @@
-import { defineConfig } from 'vitepress'
-import iterator from 'markdown-it-for-inline'
-import * as Version from '../code/ArtalkVersion.json'
-
-export default defineConfig({
-  title: 'Artalk',
-  description: '一款简洁的自托管评论系统',
-  lang: 'zh-CN',
-
-  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' }],
-    // 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,
-
-  markdown: {
-    // @link https://github.com/shikijs/shiki
-    theme: {
-      light: 'github-light',
-      dark: 'github-dark',
-    },
-    config: (md) => {
-      md.use(iterator, 'artalk_version', 'text', function (tokens, idx) {
-        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))
-      });
-    },
-  },
-
-  locales: {
-    root: {
-      label: '简体中文',
-      lang: 'zh'
-    },
-    en: {
-      label: 'English',
-      lang: 'en',
-      link: '/en/'
-    }
-  },
-
-  themeConfig: {
-    sidebar: {
-      "/guide/": [
-        {
-          text: "快速开始",
-          collapsed: false,
-          items: [
-            { text: '项目介绍', link: '/guide/intro.md' },
-            { text: '程序部署', link: '/guide/deploy.md' },
-            { text: '数据迁移', link: '/guide/transfer.md' },
-          ]
-        },
-        {
-          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/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: "进阶指南",
-          collapsed: false,
-          items: [
-            { text: '表情包', link: '/guide/frontend/emoticons.md' },
-            { text: '浏览量统计', link: '/guide/frontend/pv.md' },
-            { text: 'Latex', link: '/guide/frontend/latex.md' },
-            { text: '图片灯箱', link: '/guide/frontend/lightbox.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: '开发文档', link: '/develop/index.md', },
-          ],
-        },
-        {
-          text: "配置文档",
-          collapsed: true,
-          items: [
-            { text: '后端配置', link: '/guide/backend/config.md' },
-            { text: '前端配置', link: '/guide/frontend/config.md' },
-          ]
-        },
-        {
-          text: "部署说明",
-          collapsed: true,
-          items: [
-            { text: 'Docker', link: '/guide/backend/docker.md' },
-            { text: '守护进程', link: '/guide/backend/daemon.md' },
-            { text: '反向代理', link: '/guide/backend/reverse-proxy.md' },
-            { text: '编译构建', link: '/guide/backend/build.md' },
-            { text: '程序升级', link: '/guide/backend/update.md' },
-          ]
-        },
-        {
-          text: '更多内容',
-          collapsed: true,
-          items: [
-            { text: '安全防范', link: '/guide/security.md' },
-            { text: '扩展阅读', link: '/guide/extras.md' },
-            { text: '案例展示', link: '/guide/cases.md' },
-            { text: '关于我们', link: '/guide/about.md' },
-          ]
-        }
-      ],
-      "/develop/": [
-        {
-          text: '开发文档',
-          items: [
-            { 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: [
-      // NavbarItem
-      {
-        text: '介绍',
-        link: '/guide/intro',
-      },
-      {
-        text: '部署',
-        link: '/guide/deploy',
-      },
-      {
-        text: '配置',
-        link: '/guide/backend/config',
-      },
-      {
-        text: '迁移',
-        link: '/guide/transfer',
-      },
-      {
-        text: '案例',
-        link: '/guide/cases',
-      },
-      {
-        text: '开发',
-        link: '/develop/',
-      },
-      // NavbarGroup
-      {
-        text: '传送',
-        items: [
-          {
-            text: '代码仓库',
-            link: 'https://github.com/ArtalkJS/Artalk',
-          },
-          {
-            text: '文档镜像 (国内)',
-            link: 'https://artalk-docs.qwqaq.com'
-          }
-        ],
-      },
-    ],
-
-    socialLinks: [
-      { icon: 'github', link: 'https://github.com/ArtalkJS/Artalk' }
-    ],
-
-    algolia: {
-      appId: 'BH4D9OD16A',
-      apiKey: '37ab96e3f5a774cbbf0571b035b42adb',
-      indexName: 'artalk-js',
-      searchParameters: {
-        facetFilters: ['lang:zh-CN']
-      }
-    },
-
-    editLink: {
-      pattern: 'https://github.com/ArtalkJS/Artalk/edit/master/docs/:path',
-      text: '完善文档'
-    },
-  }
-})

docs/code/ArtalkVersion.json

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

docs/develop/event.md

@@ -1,36 +0,0 @@
-# Event
-
-## 基本事件
-
-|事件名|描述|
-|-|-|
-| `list-load` | 评论加载事件 |
-| `list-loaded` | 评论加载完成事件 |
-| `list-inserted` | 新增评论插入事件 |
-| `editor-submit` | 编辑器提交事件 |
-| `editor-submitted` | 编辑器提交完成事件 |
-| `user-changed` | 本地用户数据变更事件 |
-| `conf-loaded` | 配置变更事件 |
-| `sidebar-show` | 侧边栏显示事件 |
-| `sidebar-hide` | 侧边栏隐藏事件 |
-
-## 添加事件监听
-
-```js
-Artalk.use(ctx => {
-  ctx.on('list-loaded', () => {
-    alert('评论已加载完毕')
-  })
-})
-```
-
-## 解除事件监听
-
-```js
-let foo = function() { /* do something */ }
-
-Artalk.use(ctx => {
-  ctx.on('list-loaded', foo)
-  ctx.off('list-loaded', foo)
-})
-```

docs/develop/fe-api.md

@@ -1,106 +0,0 @@
-# Frontend API
-
-## 初始化 `Artalk.init`
-
-创建 Artalk 实例化对象。
-
-```js
-Artalk.init({
-  el:        '#Comments',
-  pageKey:   '/post/1',
-  pageTitle: '关于引入 Artalk 的这档子事',
-  server:    'http://your_domain:8080',
-  site:      'Artalk 的博客',
-})
-```
-
-## 更新配置 `Artalk.update`
-
-修改 Artalk 当前配置。
-
-```js
-Artalk.update({
-  // 新的配置...
-})
-```
-
-该函数调用后，`conf-loaded` 事件将被触发。
-
-更新配置不会自动刷新评论列表，可按需继续执行 `Artalk.reload()` 函数。
-
-注：前端的一些配置将会被后端的配置覆盖，详情见：[在后端控制前端](../guide/backend/fe-control.md)
-
-## 重新加载 `Artalk.reload`
-
-刷新 Artalk 评论列表。
-
-```js
-Artalk.reload()
-```
-
-列表加载前将触发 `list-load` 事件，加载完毕后将触发 `list-loaded` 事件。
-
-## 释放资源 `Artalk.destroy`
-
-销毁 Artalk 实例，用于资源释放。
-
-```js
-Artalk.destroy()
-```
-
-## 事件监听 `Artalk.on`
-
-添加 Artalk 事件监听。
-
-```js
-Artalk.on('list-loaded', () => {
-  alert('评论列表加载完毕')
-})
-```
-
-可监听事件类型见：[前端界面事件](./event.md)
-
-## 解除监听 `Artalk.off`
-
-解除 Artalk 事件监听。
-
-```js
-const handler = () => {
-  alert('评论列表加载完毕')
-}
-
-Artalk.on('list-loaded', handler)
-Artalk.off('list-loaded', handler)
-```
-
-## 触发事件 `Artalk.trigger`
-
-触发 Artalk 事件。
-
-```js
-Artalk.trigger('list-loaded')
-```
-
-## 扩展插件 `Artalk.use`
-
-该 API 用于扩展 Artalk。
-
-```js
-Artalk.use((ctx) => {
-  ctx.editor.setContent("Hello World")
-})
-```
-
-详情见：[插件开发](./plugs.md)
-
-## 夜间模式 `Artalk.setDarkMode`
-
-修改夜间模式，可以配合博客主题调用，例如当用户点击夜间模式切换按钮。
-
-```js
-Artalk.setDarkMode(true)
-```
-
-## 浏览量组件 `Artalk.loadCountWidget`
-
-详情见：[浏览量统计](../guide/frontend/pv.md)

docs/develop/plugs.md

@@ -1,17 +0,0 @@
-# 插件开发
-
-你可以使用 `Artalk.use` 来扩展 Artalk。
-
-```js
-Artalk.use((ctx) => {
-  ctx.editor.setContent("Hello World")
-})
-```
-
-## Context
-
-::: warning
-Context API 目前仍不稳定，开发可能会有变动，升级请关注 CHANGELOG。
-:::
-
-参考：[@artalk/types/context.d.ts](https://github.com/ArtalkJS/Artalk/blob/master/ui/packages/artalk/types/context.d.ts)

docs/docs/.gitignore

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

docs/docs/.vitepress/config.ts

@@ -0,0 +1,253 @@
+import { defineConfig } from "vitepress";
+import iterator from "markdown-it-for-inline";
+import * as Version from "../code/ArtalkVersion.json";
+
+export default defineConfig({
+  title: "Artalk",
+  description: "一款简洁的自托管评论系统",
+  lang: "zh-CN",
+
+  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",
+      },
+    ],
+    // 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,
+
+  markdown: {
+    // @link https://github.com/shikijs/shiki
+    theme: {
+      light: "github-light",
+      dark: "github-dark",
+    },
+    config: (md) => {
+      md.use(iterator, "artalk_version", "text", function (tokens, idx) {
+        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)
+        );
+      });
+    },
+  },
+
+  locales: {
+    root: {
+      label: "简体中文",
+      lang: "zh",
+      link: "https://artalk.js.org/",
+    },
+    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",
+    },
+  },
+
+  themeConfig: {
+    sidebar: {
+      "/guide/": [
+        {
+          text: "快速开始",
+          collapsed: false,
+          items: [
+            { text: "项目介绍", link: "/guide/intro.md" },
+            { text: "程序部署", link: "/guide/deploy.md" },
+            { text: "数据迁移", link: "/guide/transfer.md" },
+          ],
+        },
+        {
+          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/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: "进阶指南",
+          collapsed: false,
+          items: [
+            { text: "表情包", link: "/guide/frontend/emoticons.md" },
+            { text: "浏览量统计", link: "/guide/frontend/pv.md" },
+            { text: "Latex", link: "/guide/frontend/latex.md" },
+            { text: "图片灯箱", link: "/guide/frontend/lightbox.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: true,
+          items: [
+            { text: "后端配置", link: "/guide/backend/config.md" },
+            { text: "前端配置", link: "/guide/frontend/config.md" },
+          ],
+        },
+        {
+          text: "部署说明",
+          collapsed: true,
+          items: [
+            { text: "守护进程", link: "/guide/backend/daemon.md" },
+            { text: "反向代理", link: "/guide/backend/reverse-proxy.md" },
+            { text: "编译构建", link: "/guide/backend/build.md" },
+            { text: "程序升级", link: "/guide/backend/update.md" },
+            { text: "Docker", link: "/guide/backend/docker.md" },
+          ],
+        },
+        {
+          text: "更多内容",
+          collapsed: true,
+          items: [
+            { text: "安全防范", link: "/guide/security.md" },
+            { text: "扩展阅读", link: "/guide/extras.md" },
+            { text: "案例展示", link: "/guide/cases.md" },
+            { text: "关于我们", link: "/guide/about.md" },
+          ],
+        },
+      ],
+      "/develop/": [
+        {
+          text: "开发文档",
+          items: [
+            { 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: [
+      // NavbarItem
+      {
+        text: "介绍",
+        link: "/guide/intro",
+      },
+      {
+        text: "部署",
+        link: "/guide/deploy",
+      },
+      {
+        text: "配置",
+        link: "/guide/backend/config",
+      },
+      {
+        text: "迁移",
+        link: "/guide/transfer",
+      },
+      {
+        text: "案例",
+        link: "/guide/cases",
+      },
+      {
+        text: "开发",
+        link: "/develop/",
+      },
+      // NavbarGroup
+      {
+        text: "传送",
+        items: [
+          {
+            text: "代码仓库",
+            link: "https://github.com/ArtalkJS/Artalk",
+          },
+          {
+            text: "文档镜像 (国内)",
+            link: "https://artalk-docs.qwqaq.com",
+          },
+        ],
+      },
+    ],
+
+    socialLinks: [
+      { icon: "github", link: "https://github.com/ArtalkJS/Artalk" },
+    ],
+
+    search: {
+      provider: "algolia",
+      options: {
+        appId: "2WNJ32WVTY",
+        apiKey: "6c6ebc345a87b738264f19095b78c91c",
+        indexName: "artalk-js",
+        searchParameters: {
+          facetFilters: ["lang:zh-CN"],
+        },
+      },
+    },
+
+    editLink: {
+      pattern: "https://github.com/ArtalkJS/Artalk/edit/master/docs/:path",
+      text: "完善文档",
+    },
+  },
+
+  vite: {
+    server: {
+      open: "/guide/intro.html",
+    },
+  },
+});

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

@@ -1,53 +1,64 @@
 <template>
-  <div ref="artalkEl" style="margin-top: 20px;"></div>
+  <div ref="el" style="margin-top: 20px;"></div>
 </template>
 
 <script setup lang="ts">
-import { watch, nextTick, ref, onMounted } from 'vue'
+import { watch, nextTick, ref, onMounted, onUnmounted } from 'vue'
 import { useData, useRouter } from 'vitepress'
+import type Artalk from 'artalk'
 
-const artalkEl = ref<HTMLElement | null>(null)
+const el = ref<HTMLElement | null>(null)
 
 const router = useRouter()
 const page = useData().page
 
-onMounted(() => {
-  const script = document.createElement('script')
-  script.src = `https://artalk.qwqaq.com/dist/Artalk.js`
-  document.getElementsByTagName('head')[0].appendChild(script)
-  script.onload = () => {
-    initArtalk(page.value)
-  }
-})
+let artalk: Artalk
 
-watch(() => router.route.data.relativePath, (path) => {
+onMounted(() => {
   nextTick(() => {
-    Artalk.update(getArtalkConfByPage(page.value))
-    Artalk.reload()
+    initArtalk(getConfByPage())
   })
 })
 
-function getArtalkConfByPage(page: any) {
+watch(() => router.route.path, () => {
+  nextTick(() => {
+    artalk.update(getConfByPage())
+    artalk.reload()
+  })
+})
+
+onUnmounted(() => {
+  artalk.destroy()
+})
+
+function initArtalk(conf: any) {
+  // TODO: remove dynamic import after the new version released
+  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.title,
+    pageKey:   'https://artalk.js.org'+router.route.path,
+    pageTitle:  page.value.title,
     server:    'https://artalk.qwqaq.com',
     site:      'ArtalkDocs',
   }
 }
 
-function initArtalk(page: any) {
-  Artalk.init({
-    el:        artalkEl.value,
-    emoticons: '/assets/emoticons/default.json',
-    gravatar:   {
-      mirror: 'https://cravatar.cn/avatar/'
-    },
-    ...getArtalkConfByPage(page)
-  })
-
+function loadExtraFuncs() {
   // 图片灯箱插件
-  Artalk.on('list-loaded', () => {
+  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) => {
@@ -66,7 +77,7 @@ function initArtalk(page: any) {
 
   // 夜间模式
   const darkMode = document.querySelector('html').classList.contains('dark')
-  Artalk.setDarkMode(darkMode)
+  artalk.setDarkMode(darkMode)
 
   new MutationObserver((mList) => {
     mList.forEach((m) => {
@@ -74,7 +85,7 @@ function initArtalk(page: any) {
 
       // @ts-ignore
       const darkMode = m.target.classList.contains('dark')
-      Artalk.setDarkMode(darkMode)
+      artalk.setDarkMode(darkMode)
     })
   }).observe(document.querySelector('html'), { attributes: true })
 }

docs/docs/README.md

@@ -1,6 +1,8 @@
-## Artalk Documentation
+# Artalk Documentation
 
-> The Documentation of Artalk
+[![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
 
 ## Build
 
@@ -11,9 +13,8 @@ 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/docs/code/ArtalkVersion.json

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

docs/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/docs/develop/fe-api.md

@@ -0,0 +1,159 @@
+# Frontend API
+
+## 安装依赖
+
+用你喜欢的包管理器安装 Artalk：
+
+```bash
+pnpm add artalk
+# 或者使用 npm
+npm install artalk
+```
+
+## 创建实例 `init`
+
+调用该函数将创建并得到一个 Artalk 的实例化对象，可用于后续操作。
+
+```js
+import Artalk from 'artalk'
+
+const artalk = Artalk.init({
+  el:        '#Comments',
+  pageKey:   '/post/1',
+  pageTitle: '关于引入 Artalk 的这档子事',
+  server:    'http://your_domain:8080',
+  site:      'Artalk 的博客',
+})
+```
+
+调用该函数会向后端发起请求：
+
+1. 获取前端配置
+2. 获取评论列表
+
+配置和评论加载完毕后会分别触发 `conf-loaded` 和 `list-loaded` 事件。
+
+注：前端配置可能会被覆盖，详情见：[在后端控制前端](../guide/backend/fe-control.md)。
+
+## 释放资源 `destroy`
+
+销毁 Artalk 实例，用于资源释放。
+
+```js
+const artalk = Artalk.init({ ... })
+
+artalk.destroy()
+```
+
+释放资源将执行 Artalk 挂载的 DOM 节点删除，以及解除 Artalk 事件监听等操作。
+
+在 Vue / React 等框架中，务必在组件销毁时调用该函数，否则会造成内存泄漏：
+
+```ts
+import { onUnmounted } from 'vue'
+
+onUnmounted(() => {
+  artalk.destroy()
+})
+```
+
+## 更新配置 `update`
+
+修改 Artalk 当前配置。
+
+```js
+const artalk = Artalk.init({ ... })
+
+artalk.update({
+  // 新的配置...
+})
+```
+
+调用该函数将触发 `conf-loaded` 事件。
+
+更新配置不会自动刷新评论列表，可按需继续执行 `artalk.reload()` 函数。
+
+请注意，该函数是一个实例化对象中的方法，并非全局函数。
+
+前端配置参考：[前端配置](../guide/frontend/config.md)
+
+## 重新加载 `reload`
+
+重新从后端加载 Artalk 评论列表数据。
+
+```js
+const artalk = Artalk.init({ ... })
+
+artalk.reload()
+```
+
+列表加载前将触发 `list-load` 事件，加载完毕后将触发 `list-loaded` 事件。
+
+## 监听事件 `on`
+
+添加 Artalk 事件监听。
+
+```js
+const artalk = Artalk.init({ ... })
+
+artalk.on('list-loaded', () => {
+  alert('评论列表加载完毕')
+})
+```
+
+可参考：[前端 Event](./event.md)。
+
+## 解除监听 `off`
+
+解除 Artalk 事件监听。
+
+```js
+const artalk = Artalk.init({ ... })
+
+const handler = () => {
+  alert('评论列表加载完毕')
+}
+
+artalk.on('list-loaded', handler)
+artalk.off('list-loaded', handler)
+```
+
+## 触发事件 `trigger`
+
+触发 Artalk 事件。
+
+```js
+const artalk = Artalk.init({ ... })
+
+artalk.trigger('list-loaded')
+```
+
+## 加载插件 `use`
+
+通过 `Artalk.use` 函数加载插件。请注意，该函数是一个全局函数，并非实例化对象中的方法。通过该函数加载的插件将对所有 Artalk 实例生效。
+
+```js
+import Artalk from 'artalk'
+
+Artalk.use((ctx) => {
+  ctx.editor.setContent("Hello World")
+})
+
+const artalk = Artalk.init({ ... })
+```
+
+详情见：[插件开发](./plugs.md)
+
+## 夜间模式 `setDarkMode`
+
+修改夜间模式，可以配合博客主题调用，例如当用户点击夜间模式切换按钮。
+
+```js
+const artalk = Artalk.init({ ... })
+
+artalk.setDarkMode(true)
+```
+
+## 浏览量组件 `loadCountWidget`
+
+详情见：[浏览量统计](../guide/frontend/pv.md)

docs/docs/develop/index.md

@@ -23,6 +23,6 @@
    * [@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.d.ts](https://github.com/ArtalkJS/Artalk/blob/master/ui/packages/artalk/types/event.d.ts)
+   * [@ArtalkJS/Artalk - types/event.ts](https://github.com/ArtalkJS/Artalk/blob/master/ui/packages/artalk/types/event.ts)
 
 通过 Artalk 提供的 `API` 和 `Event`，你可以实现很多高级功能，比如编写评论管理机器人、评论提醒推送插件等。Artalk 并不为此提供技术指导，但鼓励你参考此处的文档自行定制。

docs/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/en/index.md

@@ -2,11 +2,11 @@
 layout: home
 
 title: Artalk
-titleTemplate: The Selfhosted Comment System
+titleTemplate: A Self-hosted Comment System
 
 hero:
   name: Artalk
-  text: The Selfhosted Comment System
+  text: A Self-hosted Comment System
   tagline: Elevate your online conversations with a comment system that embodies the trifecta of lightness, security, and refinement.
   actions:
     - theme: brand
@@ -30,4 +30,3 @@ features:
     title: Flexible
     details: Use Golang to interpret the excellence of multiple platforms
 ---
-

docs/docs/guide/backend/admin_notify.md

@@ -113,7 +113,7 @@ admin_notify:
 
 ![](/images/notify/tg-2.png)
 
-详情可参考：[“Bots: An introduction for developers - Telegram”](https://core.telegram.org/bots)
+详情可参考：[Bots: An introduction for developers - Telegram](https://core.telegram.org/bots)
 
 ::: tip
 
@@ -151,7 +151,7 @@ admin_notify:
 
 <img src="/images/notify/lark-3.png" width="400px">
 
-可参考：[“飞书帮助中心文档”](https://www.feishu.cn/hc/zh-CN/articles/360024984973)
+可参考：[飞书帮助中心文档](https://www.feishu.cn/hc/zh-CN/articles/360024984973)
 
 ## 钉钉
 
@@ -164,7 +164,7 @@ admin_notify:
     secret: ""
 ```
 
-可参考：[“钉钉开放文档”](https://open.dingtalk.com/document/robots/custom-robot-access)
+可参考：[钉钉开放文档](https://open.dingtalk.com/document/robots/custom-robot-access)
 
 ## Bark
 
@@ -227,7 +227,7 @@ admin_notify:
 {{link_to_reply}}
 ```
 
-可用变量和邮件模板相同，可参考：[“邮件模版”](./email.md#邮件模板)
+可用变量和邮件模板相同，可参考：[邮件模版](./email.md#邮件模板)
 
 ## 嘈杂模式 `noise_mode`
 
@@ -264,7 +264,7 @@ admin_notify:
 |`notify_subject`|通知标题     |String| 对应 admin_notify.notify_subject 配置项 |
 |`notify_body`   |通知内容     |String| 根据 admin_notify.notify_tpl 模版渲染 |
 |`comment`       |评论内容     |Object| 新创建的评论数据对象 |
-|`parent_comment`|评论回复的目标|Object| Root 根节点评论类型改项为 null |
+|`parent_comment`|评论回复的目标|Object| 如果是根节点评论值为 null |
 
 **Body 数据样本**
 

docs/docs/guide/backend/config.md

@@ -65,7 +65,7 @@ app_key: "<任意的字符>"
 locale: "zh-CN"
 ```
 
-详情参考：[“多语言”](../frontend/i18n.md)
+详情参考：[多语言](../frontend/i18n.md)
 
 ## 数据库 `db`
 
@@ -95,17 +95,30 @@ db:
   password: ""       # 密码
   charset: "utf8mb4" # 编码格式
   table_prefix: ""   # 表前缀 (例如："atk_")
+  ssl: false         # 启用 SSL
 ```
 
 数据表将在 Artalk 启动时自动完成创建，无需额外操作。
 
+#### 数据库连接字符串 (DSN)
+
+如有需要，你还可以手动配置 `db.dsn` 来指定数据库连接字符串，例如：
+
+```yaml
+db:
+  type: "mysql"
+  dsn: "mysql://myuser:mypassword@localhost:3306/mydatabase?tls=skip-verify"
+```
+
+更多内容参考：[@go-sql-driver/mysql:README.md](https://github.com/go-sql-driver/mysql)
+
 ## 管理员 `admin_users`
 
 你需要配置管理员账户，这样才能通过「[控制中心](../frontend/sidebar.md)」对站点内容进行管理。
 
 Artalk 支持多站点，你可以创建多个管理员账户，为其分配站点，让你的朋友们共用同一个后端程序。
 
-详情参考：[“管理员 × 多站点”](/guide/backend/multi-site.md)
+详情参考：[管理员 × 多站点](/guide/backend/multi-site.md)
 
 ## 可信域名 `trusted_domains`
 
@@ -165,38 +178,39 @@ Artalk.init({ site: "Artalk 官网" })
 
 ## 前端配置 `frontend`
 
-增加 `frontend` 字段内容可以在后端控制前端的配置，详情可参考：[“在后端控制前端”](/guide/backend/fe-control)。
+增加 `frontend` 字段内容可以在后端控制前端的配置，详情可参考：[在后端控制前端](/guide/backend/fe-control)。
 
 ## 邮件通知 `email`
 
 配置邮件通知，让回复通过邮件的形式通知目标用户，你可以自定义邮件发送者名称、标题、模版等。
 
-详情参考：[“后端 · 邮件通知”](/guide/backend/email.md)
+详情参考：[后端 · 邮件通知](/guide/backend/email.md)
 
 ## 多元推送 `admin_notify`
 
 你可以配置多种消息发送方式，例如飞书、Telegram 等，当收到新的评论时通知管理员。
 
-详情参考：[“后端 · 多元推送”](/guide/backend/admin_notify.md)
+详情参考：[后端 · 多元推送](/guide/backend/admin_notify.md)
 
 ## 评论审核 `moderator`
 
 配置评论审核来自动拦截垃圾评论。
 
-详情参考：[“后端 · 评论审核”](/guide/backend/moderator.md)
+详情参考：[后端 · 评论审核](/guide/backend/moderator.md)
 
 ## 验证码 `captcha`
 
 支持图片、滑动验证码，通过验证码对请求频率进行限制。
 
-详情参考：[“后端 · 验证码”](/guide/backend/captcha.md)
+详情参考：[后端 · 验证码](/guide/backend/captcha.md)
 
-## 缓存配置 `cache`
+## 高速缓存 `cache`
 
-为了提高评论系统的响应速度和性能，Artalk 内置一套缓存机制，并且默认开启，无需额外配置。但如果有需要，你也可以连接外部缓存服务器，支持 Redis 和 Memcache。
+为节省内存资源占用，缓存默认关闭。如果你对网站性能有较高要求，请手动开启。你还可以连接外部缓存服务器，支持 Redis 和 Memcache。
 
 ```yaml
 cache:
+  enabled: true   # 启用缓存 (默认关闭)
   type: "builtin" # 支持 redis, memcache, builtin (自带缓存)
   expires: 30     # 缓存过期时间 (单位：分钟)
   warm_up: false  # 程序启动时预热缓存
@@ -204,9 +218,7 @@ cache:
 ```
 
 - **warm_up**：缓存预热功能。设置为 `true`，在 Artalk 启动时会立刻对数据库内容进行全面缓存，如果你的评论数据较多，多达上万条，启动时间可能会延长。
-- **type**：缓存类型。可选：`redis`, `memcache`, `builtin`。
-
-type 默认为 `builtin`，如遇特殊情况可将缓存关闭，将其设置为 `disabled`。
+- **type**：缓存类型，默认为 `builtin`。可选：`redis`, `memcache`, `builtin`。
 
 注：如果在 Artalk 程序外部修改数据库内容，需要刷新 Artalk 缓存才能更新。
 
@@ -225,9 +237,8 @@ cache:
     db: 0          # 使用零号数据库
 ```
 
-技术细节：[Artalk 缓存机制 时序图.png](/images/artalk/artalk-cache.png)
-
-![](/images/artalk/artalk-cache.png)
+<!-- 技术细节：[Artalk 缓存机制 时序图.png](/images/artalk/artalk-cache.png) -->
+<!-- ![](/images/artalk/artalk-cache.png) -->
 
 ## 监听地址 `host`
 
@@ -337,5 +348,5 @@ test_file: "./data/artalk.log"
 
 配置文件相关代码：[/internal/config/config.go](https://github.com/ArtalkJS/Artalk/blob/master/internal/config/config.go)
 
-前往：[“前端配置”](/guide/frontend/config.md)
+前往：[前端配置](/guide/frontend/config.md)
 :::

docs/docs/guide/backend/daemon.md

@@ -0,0 +1,144 @@
+# 守护进程
+
+## Systemd
+
+前提条件：
+
+- Artalk 二进制文件，可在 [GitHub Release](https://github.com/ArtalkJS/Artalk/releases) 下载
+- `systemctl --version` 232 或更新的版本
+- `sudo` 管理员权限
+
+移动 Artalk 到 `$PATH`，例如：
+
+```bash
+sudo mv artalk /usr/bin/
+```
+
+测试是否有效：
+
+```bash
+artalk version
+```
+
+创建名为 artalk 的用户组：
+
+```bash
+sudo groupadd --system artalk
+```
+
+创建一个名为 artalk 的用户，并且拥有一个可写的 home 目录：
+
+```bash
+sudo useradd --system \
+    --gid artalk \
+    --create-home \
+    --home-dir /var/lib/artalk \
+    --shell /usr/sbin/nologin \
+    --comment "Artalk server" \
+    artalk
+```
+
+如果你有 Artalk 的配置文件，请确保刚刚创建的 artalk 用户有权限可以读取。
+
+创建服务文件：
+
+```bash
+sudo vim /etc/systemd/system/artalk.service
+```
+
+```ini
+[Unit]
+Description=Artalk
+Documentation=https://artalk.js.org
+After=network.target network-online.target
+Requires=network-online.target
+
+[Service]
+Type=notify
+User=artalk
+Group=artalk
+ExecStart=/usr/bin/artalk server -w /var/lib/artalk -c /etc/artalk/artalk.yml
+ExecReload=/bin/kill -s HUP $MAINPID
+ExecStop=/bin/kill -s QUIT $MAINPID
+TimeoutStopSec=5s
+LimitNOFILE=1048576
+LimitNPROC=512
+PrivateTmp=true
+ProtectSystem=full
+AmbientCapabilities=CAP_NET_ADMIN CAP_NET_BIND_SERVICE
+
+[Install]
+WantedBy=multi-user.target
+```
+
+请仔细检查 `ExecStart` 和 `ExecReload`。 确保二进制文件的位置和程序启动参数是正确的
+
+例如：更改 `-c` 参数的路径来指定配置文件，`-w` 参数可以更改工作目录。
+
+请注意配置文件中的所有相对路径都是基于工作目录，例如配置文件中的 `./data/` 文件夹，如果启动参数 `-w /var/lib/artalk`，将读取 `/var/lib/artalk/data/` 目录。请确保该目录中的文件对于创建的 `artalk` 账户有权限可读写。
+
+保存服务文件后，你可以设置自动启动服务：
+
+```bash 
+sudo systemctl daemon-reload
+sudo systemctl enable --now artalk
+```
+
+验证服务是否正常运行：
+
+```bash
+systemctl status artalk
+```
+
+一些常用的命令：
+
+- 启动服务：`systemctl start artalk`
+- 停止服务：`systemctl stop artalk`
+- 查看状态：`systemctl status artalk`
+- 查看日志：`journalctl -u artalk --no-pager | less +G`
+
+## Tmux
+
+tmux 将创建一个持续的命令行会话，在 SSH 或 tty 断开后保持在后台。
+
+Note: 服务器关闭或重启后，tmux 会话将被清除，需要手动重新运行程序。
+
+1. 创建会话 `tmux new -s artalk`
+2. 运行程序 `./artalk server`
+
+恢复接入会话：`tmux attach -t artalk`
+
+查看所有会话：`tmux ls`
+
+## Supervisor
+
+以宝塔面板举例：打开「软件商店」，搜索并安装「Supervisor管理器」：
+
+![](/images/baota-supervisor/0.png)
+
+安装后，打开插件，点击「添加守护程序」：
+
+![](/images/baota-supervisor/1.png)
+
+> - 启动用户：`root` 或其他
+> - 运行目录：点击右侧图标，选择 Artalk 所在目录
+> - 启动命令：`./artalk server`
+
+## Docker
+
+更新 Docker 容器的 [Restart 策略](https://docs.docker.com/config/containers/start-containers-automatically/#use-a-restart-policy) 以达到进程守护效果。
+
+```bash
+docker update --restart=unless-stopped artalk
+```
+
+## Docker Compose
+
+在 `docker-compose.yml` 文件给服务添加 `restart: unless-stopped` 策略：
+
+```diff
+version: '3'
+services:
+  artalk:
++   restart: unless-stopped
+```

docs/docs/guide/backend/data.md

@@ -0,0 +1,5 @@
+# 数据
+
+## 备份
+
+前往：[数据迁移 · 备份](/guide/transfer.md)

docs/docs/guide/backend/docker.md

@@ -12,11 +12,11 @@ Artalk 提供后端程序的 Docker 镜像，以便加速部署流程，提供
 
 :::tip
 
-推荐使用 Docker Compose：[“后端部署”](/guide/backend/install) 页面已详细讲解。
+推荐使用 Docker Compose，可参考 [程序部署](/guide/deploy) 页面的步骤。
 
 :::
 
-常规的 Docker 容器创建可参考：
+Docker 容器创建：
 
 ```bash
 # 为 Artalk 创建一个目录
@@ -112,4 +112,4 @@ docker exec -it artalk bash
 
 ## 多平台兼容性
 
-Docker 镜像暂仅提供 amd_64 构建，若需要在 ARM 架构运行，请下载 [二进制编译构建](/guide/backend/install.md#普通方式)
+Docker 镜像暂仅提供 x86、arm64 的镜像构建，如需更多平台架构版本，请下载 [二进制构建部署](/guide/deploy.md#普通方式部署)。

docs/docs/guide/backend/email.md

@@ -310,7 +310,7 @@ email:
 </div>
 ```
 
-Artalk 内置许多预设的邮件模板，例如 `mail_tpl: "default"` 使用的就是：[/email-tpl/default.html](https://github.com/ArtalkJS/Artalk/blob/master/email-tpl/default.html)
+Artalk 内置许多预设的邮件模板，例如 `mail_tpl: "default"` 使用的就是：[@ArtalkJS/Artalk:/internal/template/email_tpl/default.html](https://github.com/ArtalkJS/Artalk/blob/master/internal/template/email_tpl/default.html)
 
 ## 发向管理员的邮件
 
@@ -324,4 +324,4 @@ admin_notify:
 
 注：旧版 `email.mail_subject_to_admin` 配置项已弃用，请使用以上替代。
 
-不局限于邮件，Artalk 支持多种方式向管理员发送通知，参考：[“多元推送”](./admin_notify.md#邮件通知)。
+不局限于邮件，Artalk 支持多种方式向管理员发送通知，参考：[多元推送](./admin_notify.md#邮件通知)。

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

@@ -60,7 +60,7 @@ Artalk.init({
 
 建议 `frontend.emoticons` 填入表情包的 URL，而非 Object。
 
-参考文档：[“表情包”](/guide/frontend/emoticons)
+参考文档：[表情包](/guide/frontend/emoticons)
 
 如需传递 Object，可以将其转为 JSON 字符串格式，例如：
 

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

@@ -41,7 +41,7 @@ img_upload:
 
 频率限制跟随 `captcha` 验证码配置，当超出限制将弹出验证码。
 
-可参考：[“后端 · 验证码”](/guide/backend/captcha.md)
+可参考：[后端 · 验证码](/guide/backend/captcha.md)
 
 ## path
 

docs/docs/guide/backend/moderator.md

@@ -63,7 +63,7 @@ moderator:
 
 ## 腾讯云文本内容安全
 
-可参考：[“腾讯云文档”](https://cloud.tencent.com/document/product/1124/64508)
+可参考：[腾讯云文档](https://cloud.tencent.com/document/product/1124/64508)
 
 开通「文本内容安全」后，在「访问管理」-「API 密钥管理」新增具有权限的 Secret，然后填入配置：
 
@@ -78,7 +78,7 @@ moderator:
 
 ## 阿里云内容安全
 
-可参考：[“阿里云文档”](https://help.aliyun.com/document_detail/28417.html)
+可参考：[阿里云文档](https://help.aliyun.com/document_detail/28417.html)
 
 开通「阿里云内容安全」后，阿里云后台创建 Access Key 并填入配置：
 

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

@@ -26,7 +26,7 @@ docker exec -it artalk artalk admin
 
 ## 站点的创建和管理
 
-你可以在侧边栏「[控制中心](../frontend/sidebar.md#控制中心)」创建多个站点，管理站点和快速切换站点，详情可参考：[“侧边栏”](/guide/frontend/sidebar.html)。
+你可以在侧边栏「[控制中心](../frontend/sidebar.md#控制中心)」创建多个站点，管理站点和快速切换站点，详情可参考：[侧边栏](/guide/frontend/sidebar.html)。
 
 ## 管理员配置
 
@@ -66,7 +66,7 @@ admin_users:
 
   然后配置填写：`"(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)
+  命令解释参考：[Compute bcrypt hash from command line](https://unix.stackexchange.com/questions/307994/compute-bcrypt-hash-from-command-line#answer-419855)
 
 - **badge_name**：用户显示的头衔徽标文字。
 - **badge_color**：用户显示的头衔徽标背景颜色。

docs/docs/guide/backend/reverse-proxy.md

@@ -1,5 +1,25 @@
 # 反向代理
 
+## Caddy
+
+**/etc/caddy/Caddyfile**
+
+```nginx
+artalk.your_domain.com {
+  tls /etc/caddy/ssl/cert.pem /etc/caddy/ssl/cert.key
+
+  reverse_proxy http://localhost:23366 {
+    header_up X-Forwarded-For {header.X-Forwarded-For}
+  }
+}
+```
+
+执行重载命令：
+
+```sh
+sudo systemctl reload caddy
+```
+
 ## Nginx
 
 假定：
@@ -67,16 +87,6 @@ Artalk.init({ server: "http://artalk.your_domain.com" })
 尤其是运行在 Docker 容器内的 artalk，注意检查 IP 和端口是否能够被 Nginx 正常访问
 :::
 
-## Caddy
-
-创建 Caddyfile：
-
-```
-artalk.your_domain.com {
-  reverse_proxy / http://localhost:23366
-}
-```
-
 ## Apache
 
 需要启用反代模块 `mod_proxy.c`

docs/docs/guide/backend/update.md

@@ -12,13 +12,13 @@
 
 :::tip
 
-执行 `./artalk upgrade -f` 携带参数 `-f` 来进行同版本号的补充更新。
+执行 `./artalk upgrade -f` 携带参数 `-f` 执行强制更新。
 
 :::
 
 ## Docker 升级
 
-可参考：[“Docker · 升级”](./docker.md#升级)
+可参考：[Docker · 升级](./docker.md#升级)
 
 ## 普通方式
 

docs/docs/guide/deploy.md

@@ -51,14 +51,11 @@ Artalk.init({
 
 在控制台，你可以根据喜好配置评论系统、[将评论迁移到 Artalk](./transfer.md)。
 
-祝贺！你已成功完成 Artalk 部署 🥳
+🥳 你已成功完成 Artalk 部署！
 
 ## 普通方式部署
 
 1. 前往 [GitHub Release](https://github.com/ArtalkJS/Artalk/releases) 下载程序压缩包
-
-  > 注：我们已将 ArtalkGo 与主仓库合并，历史旧版可在[此页面](https://github.com/ArtalkJS/ArtalkGo/releases)查看，日后新版将在[新页面](https://github.com/ArtalkJS/Artalk/releases)发布。
-
 2. 提取压缩包：`tar -zxvf artalk_版本号_系统_架构.tar.gz`
 3. 运行程序 `./artalk server`
 4. 前端配置
@@ -67,25 +64,16 @@ Artalk.init({
     Artalk.init({ server: "http://your_domain:23366" })
     ```
 
-**其它可选操作：**
+**进一步操作：**
 
-- [“反向代理端口到 80 / 443 (Nginx, Apache)”](./backend/reverse-proxy.md)
-- ["持久化运作 (tmux, systemd, supervisor)"](./backend/daemon.md)
+- [守护进程 (Systemd, Supervisor)](./backend/daemon.md)
+- [反向代理 (Caddy, Nginx, Apache)](./backend/reverse-proxy.md)
 
-**附表：文件名释义表**
+如果有需要，你还可以自行编译程序，参考：[后端构建](./backend/build.md)。
 
-|文件名|操作系统|CPU 架构|
-|:-|:-:|:-:|
-|artalk_linux_amd64.tar.gz|Linux|x86_64|
-|artalk_linux_arm64.tar.gz|Linux|ARM64|
-|artalk_linux_arm7.tar.gz|Linux|ARMv7|
-|artalk_windows_amd64.zip|Windows|x86_64|
-|artalk_darwin_arm64.tar.gz|macOS|Apple Silicon|
-|artalk_darwin_amd64.tar.gz|macOS|Intel Chip|
+## Compose 部署
 
-## Docker Compose 部署
-
-提供 docker-compose.yaml 文件可供参考：
+**compose.yaml**
 
 ```yaml
 version: "3.5"
@@ -100,7 +88,7 @@ services:
       - ./data:/data
 ```
 
-在与配置文件相同的目录执行命令创建容器：
+执行命令创建容器：
 
 ```bash
 docker-compose up -d
@@ -118,11 +106,7 @@ docker-compose exec artalk bash # 进入容器
 
 :::
 
-> 详细可见：[“后端 · Docker”](./backend/docker.md)
-
-## 自行编译并运行
-
-可参考：[“后端构建”](./backend/build.md)
+可参考：[Docker 部署文档](./backend/docker.md)
 
 ## CDN 资源
 
@@ -135,7 +119,21 @@ docker-compose exec artalk bash # 进入容器
 
 Artalk 后端程序内嵌了前端 JS、CSS 文件，使用公共 CDN 资源请注意前后端版本的兼容性。
 
-Artalk 静态资源通过上游 [CDNJS](https://cdnjs.com/) 分发，国内有许多镜像可供选择：
+Artalk 静态资源通过上游 CDNJS 分发，以下镜像资源可供选择：
+
+**CDNJS**
+
+> https://cdnjs.cloudflare.com/ajax/libs/artalk/:ArtalkVersion:/Artalk.js
+>
+> https://cdnjs.cloudflare.com/ajax/libs/artalk/:ArtalkVersion:/Artalk.css
+
+**Staticfile CDN (国内)**
+
+> https://cdn.staticfile.org/artalk/:ArtalkVersion:/Artalk.js
+>
+> https://cdn.staticfile.org/artalk/:ArtalkVersion:/Artalk.css
+
+::: details 查看更多
 
 **BootCDN (国内)**
 
@@ -143,18 +141,11 @@ Artalk 静态资源通过上游 [CDNJS](https://cdnjs.com/) 分发，国内有
 >
 > https://cdn.bootcdn.net/ajax/libs/artalk/:ArtalkVersion:/Artalk.css
 
+**75CDN (国内)**
 
-**ElemeCDN (国内)**
-
-> https://npm.elemecdn.com/artalk@:ArtalkVersion:/dist/Artalk.js
+> https://lib.baomitu.com/artalk/:ArtalkVersion:/Artalk.js
 >
-> https://npm.elemecdn.com/artalk@:ArtalkVersion:/dist/Artalk.css
-
-**CDNJS**
-
-> https://cdnjs.cloudflare.com/ajax/libs/artalk/:ArtalkVersion:/Artalk.js
->
-> https://cdnjs.cloudflare.com/ajax/libs/artalk/:ArtalkVersion:/Artalk.css
+> https://lib.baomitu.com/artalk/:ArtalkVersion:/Artalk.css
 
 **UNPKG**
 
@@ -168,11 +159,9 @@ Artalk 静态资源通过上游 [CDNJS](https://cdnjs.com/) 分发，国内有
 > 
 > https://cdn.jsdelivr.net/npm/artalk@:ArtalkVersion:/dist/Artalk.css
 
-## ArtalkLite
+:::
 
-可选择精简版 [ArtalkLite](./frontend/artalk-lite.md)：体积更小、更简约。
-
-## Node 环境
+## Node 项目
 
 ```bash
 pnpm add artalk
@@ -189,13 +178,20 @@ Artalk.init({
 })
 ```
 
-## 何时引入、何时 init？
+可参考：
 
-- 可以在任意位置引入 JS 和 CSS 资源，但需确保 JS 引入在执行 `Artalk.init({})` 前。
-- 执行 `Artalk.init({ el: '#x' })` 时，需要确保 `<div id="x"></div>` 存在于页面当中。
-
-可参考：[“前端框架引入”](./frontend/import-framework.md) / [“博客引入”](./frontend/import-blog.md)
+- [置入框架文档](./frontend/import-framework.md)
+- [置入博客文档](./frontend/import-blog.md)
+- [前端 API](../develop/fe-api.md)
 
 ## 数据导入
 
-从其他评论系统导入数据：[“数据迁移”](./transfer.md)
+从其他评论系统导入数据：[数据迁移](./transfer.md)
+
+## ArtalkLite
+
+可选择精简版 [ArtalkLite](./frontend/artalk-lite.md)：体积更小、更简约。
+
+## 开发环境
+
+可参考：[开发者指南](https://github.com/ArtalkJS/Artalk/blob/master/CONTRIBUTING.md)

docs/docs/guide/extras.md

@@ -14,8 +14,9 @@ Artalk 离不开社区的支持与帮助，**是你们让 Artalk 走得更远！
 - [Vuepress配置评论插件为Artalk](https://wiki.eryajf.net/pages/b74c2b/)
 - [Fly.io 部署 Artalk 评论系统](https://wayjam.me/posts/artalk-deploy-on-flyio/)
 - [Railway.app 部署 Artalk 评论系统](https://blog.moraxyc.com/post/eidb8276/)
+- [Render.com 部署Artalk自托管评论系统](https://www.leenhawk.com/posts/3932123804/)
 
-更多新版读物正在撰写当中（
+更多新版读物正在撰写当中...
 
 ## Artalk v1
 

docs/docs/guide/frontend/config.md

@@ -1,18 +1,19 @@
 # 前端配置
 
 ```js
-Artalk.init({ 你的配置... })
-Artalk.update({ 更新配置... })
+const artalk = Artalk.init({ ... })
+
+artalk.update({ ... })
 ```
 
 - 默认配置：[defaults.ts](https://github.com/ArtalkJS/Artalk/blob/master/ui/packages/artalk/src/defaults.ts)
-- 声明文件：[artalk-config.d.ts](https://github.com/ArtalkJS/Artalk/blob/master/ui/packages/artalk/types/artalk-config.d.ts)
+- 声明文件：[config.ts](https://github.com/ArtalkJS/Artalk/blob/master/ui/packages/artalk/types/config.ts)
 
 ## 轻松配置
 
 推荐在侧边栏 “[控制中心](/guide/frontend/sidebar.md)” 通过图形界面修改前端的配置，而无需在代码中对界面进行设定。
 
-注：前端的设定可能会被后端覆盖，更多内容参考：[“在后端控制前端”](/guide/backend/fe-control.md)
+注：前端的设定可能会被后端覆盖，更多内容参考：[在后端控制前端](/guide/backend/fe-control.md)
 
 ## 基本配置（必填项）
 
@@ -36,7 +37,7 @@ Artalk.update({ 更新配置... })
 
 可以填写由博客系统生成的 `固定链接`，但建议使用相对路径以便日后切换域名。
 
-参考：[“关于使用相对 / 绝对路径”](/guide/backend/relative-path.md)
+参考：[关于使用相对 / 绝对路径](/guide/backend/relative-path.md)
 
 ### pageTitle
 
@@ -84,7 +85,7 @@ Artalk 支持多站点统一管理，此项用于站点隔离。
 
 可以在后端的配置文件中定义前端的配置，让前端配置始终跟随后端。
 
-详情可参考：[“在后端控制前端”](/guide/backend/fe-control)
+详情可参考：[在后端控制前端](/guide/backend/fe-control)
 
 ## 国际化 (i18n)
 
@@ -99,7 +100,7 @@ Artalk 支持多站点统一管理，此项用于站点隔离。
 
 欢迎提交 PR 帮助翻译 Artalk 的多语言，为社区贡献一份力量！
 
-详情参考：[“多语言”](./i18n.md)
+详情参考：[多语言](./i18n.md)
 
 ## 请求
 
@@ -121,7 +122,7 @@ Artalk 支持多站点统一管理，此项用于站点隔离。
 - 类型：`Object|Array|String|Boolean`
 - 默认值："[https://cdn.jsdelivr.net/gh/ArtalkJS/Emoticons/grps/default.json](https://cdn.jsdelivr.net/gh/ArtalkJS/Emoticons/grps/default.json)"
 
-详细内容：[“前端 · 表情包”](/guide/frontend/emoticons.md)
+详细内容：[前端 · 表情包](/guide/frontend/emoticons.md)
 
 更新兼容 [OwO 格式](https://github.com/DIYgod/OwO)，支持 URL 动态加载。
 
@@ -175,7 +176,7 @@ JS DELIVR 在中国大陆的 [ICP 牌照已被吊销](https://github.com/jsdeliv
 代码动态修改 darkMode：
 
 ```js
-Artalk.setDarkMode(true)
+artalk.setDarkMode(true)
 ```
 
 > 参考代码：“[index.html](https://github.com/ArtalkJS/Artalk/blob/master/ui/packages/artalk/index.html#L97-L150)”
@@ -268,7 +269,7 @@ pvEl 和 countEl 元素标签都可以设置 `data-page-key` 属性值，来指
 **显示用户的 UserAgent 信息徽标**
 
 - 类型：`Boolean`
-- 默认值：`true`
+- 默认值：`false`
 
 ### listSort
 

docs/docs/guide/frontend/emoticons.md

@@ -9,7 +9,7 @@ frontend:
 
 ## 表情包预设
 
-Artalk 社区提供许多表情包预设，你能够挑选几套喜欢的表情包，仅需简单的配置，轻松添加到你的评论系统中，前往仓库：[“@ArtalkJS/Emoticons”](https://github.com/ArtalkJS/Emoticons)。
+Artalk 社区提供许多表情包预设，你能够挑选几套喜欢的表情包，仅需简单的配置，轻松添加到你的评论系统中，前往仓库：[@ArtalkJS/Emoticons](https://github.com/ArtalkJS/Emoticons)。
 
 ## 格式支持
 
@@ -57,7 +57,7 @@ Artalk 除了支持 OwO 格式外，还内置支持一种标准的表情包列
 
 ::: warning
 
-前端的配置将默认被后端覆盖，详情参考：[“在后端控制前端”](/guide/backend/fe-control.html)
+前端的配置将默认被后端覆盖，详情参考：[在后端控制前端](/guide/backend/fe-control.html)
 
 :::
 

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

@@ -4,6 +4,11 @@
 
 <<< @/code/quick-start/cdn.html
 
+#### 什么时候执行 `Artalk.init({})`？
+
+- 可以在任意位置引入 JS 和 CSS 资源，但需确保 JS 引入在执行 `Artalk.init({})` 前。
+- 执行 `Artalk.init({ el: '#artalk' })` 前需要确保 `<div id="artalk"></div>` 在页面当中。
+
 ## Hugo
 
 创建模板文件 `/主题目录/layouts/partials/comment/artalk.html`：
@@ -99,66 +104,36 @@ NexT 主题可以安装 [Hexo NexT 主题的 Artalk 插件](https://github.com/l
 
 :::
 
+## VitePress
+
+可参考：[@ArtalkJS/Artalk:/docs/.vitepress](https://github.com/ArtalkJS/Artalk/tree/master/docs/.vitepress)
+
+- `config.ts` 修改配置引入 CSS 资源
+- `theme/Artalk.vue` 创建组件
+- `theme/index.ts` 注册组件
+- `theme/Layout.vue` 使用组件
+
+注：SSG 应用需通过 `import()` 函数异步引入 Artalk，否则会导致构建失败。
+
+```ts
+import('artalk').then(({ default: Artalk }) => {
+  artalk = Artalk.init({
+    //...
+  })
+})
+```
+
+参考文件：[.vitepress/theme/Artalk.vue](https://github.com/ArtalkJS/Artalk/blob/master/docs/.vitepress/theme/Artalk.vue)
 
 ## VuePress
 
-以 [VuePress v2](https://github.com/vuepress/vuepress-next) 为例，继承默认主题 `@vuepress/theme-default`
+（待补充）
 
-可参考：[“/.vuepress/theme/Artalk.vue”](https://github.com/ArtalkJS/Docs/blob/eef37bca8cc0c9973bf121fdef4014dcd940f104/docs/.vuepress/theme/Artalk.vue) 创建 Artalk 评论组件。
+::: tip 提示
 
-在 `/.vuepress/theme/clientAppEnhance.ts` 文件中全局注册组件：
+可参考：[置入框架](./import-framework.md)
 
-```ts
-import { defineClientAppEnhance } from '@vuepress/client'
-
-import Artalk from './Artalk.vue'
-
-export default defineClientAppEnhance(({ app, router, siteData }) => {
-  app.component('Artalk', Artalk)
-})
-```
-
-主题布局 `/.vuepress/theme/Layout.vue`：
-
-```vue
-<template>
-  <Layout>
-    <template #page-bottom>
-      <div class="page-meta">
-        <!-- Artalk -->
-        <Artalk />
-      </div>
-    </template>
-  </Layout>
-</template>
-
-<script lang="ts">
-import { defineComponent, nextTick } from 'vue'
-import { useRouter } from 'vue-router'
-import Layout from '@vuepress/theme-default/lib/client/layouts/Layout.vue'
-
-export default defineComponent({
-  components: { Layout },
-  mounted: () => {
-  }
-})
-</script>
-```
-
-主题配置文件 `/.vuepress/theme/index.ts`：
-
-```ts
-import { path } from '@vuepress/utils'
-
-export default ({
-  name: 'vuepress-theme-local',
-  extends: '@vuepress/theme-default',
-  layouts: {
-    Layout: path.resolve(__dirname, 'Layout.vue'),
-  },
-  clientAppEnhanceFiles: path.resolve(__dirname, 'clientAppEnhance.ts'),
-})
-```
+:::
 
 ## Typecho
 

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

@@ -0,0 +1,146 @@
+# 置入框架
+
+## 安装 Artalk
+
+通过包管理工具引入 Artalk，推荐使用 [pnpm](https://pnpm.io/zh/)
+
+```bash
+pnpm add artalk
+```
+
+## Vue
+
+Vue 3 + TypeScript 例：
+
+```vue
+<template>
+  <view ref="el"></view>
+</template>
+
+<script lang="ts" setup>
+import { onMounted, onUnmounted, ref } from 'vue'
+import { useRoute } from 'vue-router'
+import 'artalk/dist/Artalk.css'
+import Artalk from 'artalk'
+
+const el = ref<HTMLElement>()
+const route = useRoute()
+
+let artalk: Artalk
+
+onMounted(() => {
+  artalk = Artalk.init({
+    el:        el.value,
+    pageKey:   route.path,
+    pageTitle: `${document.title}`,
+    server:    'http://localhost:8080',
+    site:      'Artalk 的博客',
+    // ...
+  })
+})
+
+onUnmounted(() => {
+  artalk.destroy()
+})
+</script>
+```
+
+## React
+
+```tsx
+import React, { useEffect, useRef } from 'react';
+import { useLocation } from 'react-router-dom';
+import 'artalk/dist/Artalk.css';
+import Artalk from 'artalk';
+
+const ArtalkComment = () => {
+  const el = useRef(null);
+  const location = useLocation();
+  let artalk = null;
+
+  useEffect(() => {
+    artalk = new Artalk({
+      el: el.current,
+      pageKey: location.pathname,
+      pageTitle: document.title,
+      server: 'http://localhost:8080',
+      site: 'Artalk 的博客',
+      // ...
+    });
+
+    return () => {
+      if (artalk) {
+        artalk.destroy();
+      }
+    };
+  }, [location.pathname]);
+
+  return <div ref={el}></div>;
+};
+
+export default ArtalkComment;
+```
+
+```jsx
+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} />
+    )
+  }
+}
+```
+
+## Svelte
+
+```html
+<script>
+  import { onMount, onDestroy } from 'svelte';
+  import 'artalk/dist/Artalk.css';
+  import Artalk from 'artalk';
+
+  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/guide/frontend/index.md

@@ -0,0 +1,7 @@
+# ArtalkJS
+
+Artalk 拥有一个前端，[GitHub 代码仓库](https://github.com/ArtalkJS/Artalk)。
+
+## 特性
+
+可见：[README.md · 特性](https://github.com/ArtalkJS/Artalk#%E7%89%B9%E6%80%A7)

docs/docs/guide/frontend/pv.md

@@ -6,7 +6,7 @@ Artalk 内置页面浏览量统计功能，你可以在你的页面任意位置
 <span id="ArtalkPV"></span>
 ```
 
-当 Artalk 加载完毕时，该标签内容将修改为页面的浏览量计数。
+当 Artalk 评论列表加载完毕时，该标签内容将修改为页面的浏览量计数。
 
 Artalk 加载需要时间，所以你可以给它一个占位字符：
 
@@ -14,7 +14,7 @@ Artalk 加载需要时间，所以你可以给它一个占位字符：
 <span id="ArtalkPV">加载中...</span>
 ```
 
-你也可以绑定使用其他的元素，修改 Artalk 配置项，例如：
+配置项 `pvEl` 的默认值是 `"#ArtalkPV"`，可修改将评论量加载到指定元素，例如：
 
 ```js
 Artalk.init({
@@ -22,9 +22,12 @@ Artalk.init({
 })
 ```
 
-### 显示多个页面的浏览量
+### 加载多个页面的浏览量
+
+你能在除评论页面之外的任何页面，例如「文章列表」页，显示页面浏览量或评论数。
+
+在非评论页，无需调用 `Artalk.init` 加载评论框 (会使页面浏览量 PV 数增加)，仅调用 `loadCountWidget` 静态方法即可：
 
-你能在除评论页面之外的任何页面，例如「文章列表」页，显示页面浏览量或评论数：
 
 ```js
 Artalk.loadCountWidget({
@@ -35,8 +38,6 @@ Artalk.loadCountWidget({
 });
 ```
 
-在非评论页时，就无需再 Artalk.init 实例了 (否则页面浏览量 PV 数会无故增加)，仅调用 `loadCountWidget` 静态方法即可。
-
 然后你可以放置多个 `#ArtalkPV` 元素，通过属性 `data-page-key` 来指定需要查询的页面：
 
 ```html

docs/docs/guide/frontend/sidebar.md

@@ -40,4 +40,4 @@
 
 ## 设置
 
-登陆管理员账户可进入到 “控制中心” 的图形设置界面，轻松地对 [“配置文件”](/guide/backend/config.md) 以及 [“前端的配置”](/guide/frontend/config.md) 进行修改，而无需手动编辑复杂的配置文件。
+登陆管理员账户可进入到 “控制中心” 的图形设置界面，轻松地对 [配置文件](/guide/backend/config.md) 以及 [前端的配置](/guide/frontend/config.md) 进行修改，而无需手动编辑复杂的配置文件。

docs/docs/guide/intro.md

@@ -36,7 +36,7 @@
 
    不论是 Vue、React、Svelte 的前端项目，还是 WordPress、Typecho、Hexo 等博客系统，都可以快速引入 Artalk，结合诸位的聪明才智，我们相信 Artalk 能够自如应对各种业务场景。
 
-> 更多支持 / 计划的功能，详见：[“README.md”](https://github.com/ArtalkJS/Artalk#todos)。
+> 更多支持 / 计划的功能，详见：[README.md](https://github.com/ArtalkJS/Artalk#todos)。
 
 ## 用户体验
 
@@ -64,7 +64,7 @@ Artalk 社区是包容开放的社区，我们欢迎不同水平的人员帮助
 
 “More action, less talk”，Artalk 社区不欢迎无意义的争论，我们希望社区成员和谐共处、为社区发展出谋划策。在提出问题前，你应当读过《[提问的智慧](https://lug.ustc.edu.cn/wiki/doc/smart-questions/)》，这可能决定了你最终是否能得到有用的回答。在表达观点前，你应当具备基本的礼仪，比如保持平和的态度、使用得体的语言，切忌恶语相向、冷嘲热讽、不尊重他人信仰和立场等。
 
-我们作为开源精神的推崇者以及实践者，希望我们所创造的自由软件，都应该被自由的使用，自由的研究，自由的更改和自由的分享。本项目前后端代码使用 [MIT](https://github.com/ArtalkJS/Artalk/blob/master/LICENSE) 协议开源，文档请遵循知识共享许可协议 ([Creative Commons License](https://creativecommons.org/licenses/by-nc-sa/4.0/deed.zh))。
+我们作为开源精神的推崇者以及实践者，希望我们所创造的自由软件，都应该被自由的使用，自由的研究，自由的更改和自由的分享。本项目主程序使用 [MIT](https://github.com/ArtalkJS/Artalk/blob/master/LICENSE) 协议开源，文档使用 [CC](https://creativecommons.org/licenses/by-nc-sa/4.0/deed.zh) 许可协议。
 ::: tip 立即为社区贡献力量？
 
   - 浏览开发者资料（[开发文档](../develop/index.md) / [CONTRIBUTING.md](https://github.com/ArtalkJS/Artalk/blob/master/CONTRIBUTING.md)）

docs/docs/guide/security.md

@@ -0,0 +1,25 @@
+# 安全防范
+
+## 用户身份凭证存储
+
+Artalk 在努力保护用户的安全。参考 [OWASP 安全备忘录](https://cheatsheetseries.owasp.org/cheatsheets/DOM_based_XSS_Prevention_Cheat_Sheet.html) 中提到的内容，Artalk 的开发对于来自用户输入的任何数据始终持以怀疑的态度，我们严格遵循以下准则防范 XSS 攻击：
+
+- 不直接或间接地调用 `innerHTML` 输出未经处理的用户输入数据，而是使用 `innerText`。
+- 需要额外注意将用户输入数据带入程序上下文时的处理，防止非法数据在页面被执行。例如不要在 `setAttribute` 时直接引用来自用户的输入值。
+- 注意类型合法性判断、做好类型的转换。例如 URL 以 `javascript:` 前缀开头应被视为非法。
+- 不要去调用一些高风险的内置函数，因为会带来潜在的安全隐患。例如：`eval()`。
+- 注意来自内置 API 的数据，应任被视为不可信的。例如：`location.hash.split("#")[1]`。
+
+## 跨域请求安全性
+
+参考：[Cross-Origin Resource Sharing (CORS) ｜ MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)
+
+【待补充】
+
+## API 设计安全性
+
+【待补充】
+
+## 写在结尾
+
+Artalk 的功能在不断完善，同时也在不断向提高安全性的目标努力，但在努力的同时还是难免发生一些疏忽和遗漏，若遇问题或有好的建议，欢迎反馈与指正。

docs/docs/guide/transfer.md

@@ -2,11 +2,7 @@
 
 ## 数据行囊
 
-数据行囊（Artrans）是 Artalk 持久化数据保存规范格式。
-
-Artran = Art + Ran (艺术 + 奔跑)
-
-即 “奔跑的艺术”，又称~~艺术之润~~ Ran 为 Run 的过去式，代表已经润了（
+数据行囊（Artrans = Art + Ran）是 Artalk 持久化数据保存规范格式。
 
 ::: details Artran 格式定义
 
@@ -61,7 +57,7 @@ Artran = Art + Ran (艺术 + 奔跑)
 
 转换为 `.artrans` 格式的数据文件可以导入 Artalk：
 
-- **前端导入**：你可在「[控制中心](./frontend/sidebar.md#控制中心)」找到「迁移」选项卡，并根据提示导入 Artrans。
+- **控制中心导入**：你可在「[控制中心](./frontend/sidebar.md#控制中心)」找到「迁移」选项卡，并根据提示导入 Artrans。
 - **命令行导入**：执行 `artalk import -h` 查阅帮助文档。
 
 ## 获取源数据
@@ -213,4 +209,4 @@ artalk export | gzip -9 | ssh username@remote_ip "cat > ~/backup/artrans.gz"
 
 目前已支持将 Typecho、WordPress、Valine、Waline、Disqus、Commento、Twikoo 等类型的数据转为 Artrans，但鉴于评论系统的多样性，虽然我们已经对上述类型数据做了适配，但仍然还有许多并未兼容。如果你恰巧正在使用未被适配的评论系统，你除了等待 Artalk 官方支持之外，还可以尝试了解 Artrans 数据格式后自主编写评论数据导入导出工具。如果你觉得自己的工具写得不错，我们十分乐意将其收录在内，让我们共同创造一个能够在不同评论系统之间自由切换的工具。
 
-前往：[“Artransfer 迁移工具代码仓库”](https://github.com/ArtalkJS/Artransfer)
+前往：[Artransfer 迁移工具代码仓库](https://github.com/ArtalkJS/Artransfer)