add english

Qexo · Aug 25, 2024 · c234d1e · c234d1e
1 parent 7ddb99b
commit c234d1e
Show file tree

Hide file tree

Showing 23 changed files with 5,210 additions and 1,698 deletions.
diff --git a/docs/.vitepress/config.js b/docs/.vitepress/config.js
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
@@ -0,0 +1,155 @@
+import { defineConfig } from "vitepress";
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  head: [
+    ["link", { rel: "icon", href: "/favicon.ico" }],
+    [
+      "script",
+      {},
+      `var _hmt = _hmt || [];(function() {var hm = document.createElement("script");hm.src = "https://hm.baidu.com/hm.js?1bc2cefab19bfc10c993dca7e1513b82";var s = document.getElementsByTagName("script")[0];s.parentNode.insertBefore(hm, s);})();`,
+    ],
+  ],
+  base: "/qexo/",
+
+  lastUpdated: true,
+  markdown: {
+    lineNumbers: true,
+  },
+
+  locales: {
+    root: {
+      label: "简体中文",
+      lang: "zh-CN",
+      link: "/",
+      title: "Qexo 文档",
+      description: "一个快速、强大、漂亮的在线 静态博客 管理器",
+      themeConfig: {
+        sidebar: [
+          {
+            text: "上手",
+            items: [
+              { text: "快速开始", link: "/start" },
+              { text: "部署程序", link: "/start/build" },
+              { text: "如何更新", link: "/start/update" },
+              { text: "常见问题", link: "/start/questions" },
+            ],
+          },
+          {
+            text: "配置",
+            items: [
+              { text: "博客配置", link: "/configs/provider" },
+              { text: "Vercel配置", link: "/configs/vercel" },
+              { text: "图床配置", link: "/configs/upload" },
+              { text: "统计配置", link: "/configs/statistic" },
+              { text: "推送配置", link: "/configs/onepush" },
+            ],
+          },
+          {
+            text: "拓展",
+            items: [
+              { text: "接入友链", link: "/exts/flinks" },
+              { text: "接入说说", link: "/exts/talks" },
+              { text: "自定字段", link: "/exts/custom" },
+              { text: "访客统计", link: "/exts/statistic" },
+            ],
+          },
+          {
+            text: "实践",
+            items: [
+              { text: "SM.MS图床", link: "/practice/smms" },
+              { text: "使用短链接", link: "/practice/abbrlink" },
+            ],
+          },
+          {
+            text: "开发",
+            items: [
+              { text: "API文档", link: "/dev/api" },
+              { text: "鸣谢", link: "/dev/thanks" },
+            ],
+          },
+        ],
+        nav: [
+          { text: "快速上手", link: "/start.html" },
+          {
+            text: "对外API",
+            link: "/dev/api",
+          },
+          {
+            text: "Github",
+            link: "https://github.com/Qexo/Qexo",
+            target: "_blank",
+          },
+        ],
+      },
+    },
+    en: {
+      label: "English",
+      lang: "en",
+      link: "/en/",
+      title: "Qexo Docs",
+      description: "A fast, powerful, and beautiful online blog manager",
+      themeConfig: {
+        sidebar: [
+          {
+            text: "Start",
+            items: [
+              { text: "Quick Start", link: "/en/start" },
+              { text: "Build", link: "/en/start/build" },
+              { text: "Update", link: "/en/start/update" },
+              { text: "FAQ", link: "/en/start/questions" },
+            ],
+          },
+          {
+            text: "Configurations",
+            items: [
+              { text: "Blog", link: "/en/configs/provider" },
+              { text: "Vercel", link: "/en/configs/vercel" },
+              { text: "Image Upload", link: "/en/configs/upload" },
+              { text: "Statistic", link: "/en/configs/statistic" },
+              { text: "Onepush", link: "/en/configs/onepush" },
+            ],
+          },
+          {
+            text: "Extensions",
+            items: [
+              { text: "Friend Links", link: "/en/exts/flinks" },
+              { text: "Qexo Talks", link: "/en/exts/talks" },
+              { text: "Custom Fields", link: "/en/exts/custom" },
+              { text: "PV Statistic", link: "/en/exts/statistic" },
+            ],
+          },
+          {
+            text: "Practice",
+            items: [
+              { text: "SM.MS", link: "/en/practice/smms" },
+              { text: "Short Links", link: "/en/practice/abbrlink" },
+            ],
+          },
+          {
+            text: "Develop",
+            items: [
+              { text: "API Docs", link: "/en/dev/api" },
+              { text: "Acknowledgements", link: "/en/dev/thanks" },
+            ],
+          },
+        ],
+        nav: [
+          { text: "Quick Start", link: "/en/start.html" },
+          {
+            text: "Public API",
+            link: "/en/dev/api",
+          },
+          {
+            text: "Github",
+            link: "https://github.com/Qexo/Qexo",
+            target: "_blank",
+          },
+        ],
+      },
+    },
+  },
+  themeConfig: {
+    socialLinks: [{ icon: "github", link: "https://github.com/Qexo/Qexo" }],
+  },
+});
diff --git a/docs/en/configs/onepush.md b/docs/en/configs/onepush.md
@@ -0,0 +1,22 @@
+# Push Notification Configuration
+
+With OnePush, you can quickly push updates, link applications, and other messages to your devices.
+
+Refer to the [OnePush repository](https://github.com/y1ndan/onepush) for more details. Qexo currently supports the following notification services:
+
+- [Bark](https://apps.apple.com/us/app/bark-customed-notifications/id1403753865)
+- [Discord](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks)
+- [Telegram](https://core.telegram.org/bots)
+- [ServerChan](https://sc.ftqq.com/3.version)
+- [ServerChanTurbo](https://sct.ftqq.com)
+- [WechatWorkApp](https://work.weixin.qq.com/api/doc/90000/90135/90236)
+- [WechatWorkBot](https://work.weixin.qq.com/api/doc/90000/90136/91770)
+- [Pushplus](https://www.pushplus.plus/doc)
+- [go-cqhttp](https://docs.go-cqhttp.org)
+- [Qmsg](https://qmsg.zendee.cn/api.html)
+- [DingTalk](https://developers.dingtalk.com/document/app/custom-robot-access)
+- [Lark](https://open.feishu.cn/document/ukTMukTMukTM/ucTM5YjL3ETO24yNxkjN)
+- [SMTP](https://docs.python.org/3/library/smtplib.html)
+- [Pushdeer](https://www.pushdeer.com/official.html) 
+
+For customized providers, you can use these services to push notifications.
diff --git a/docs/en/configs/provider.md b/docs/en/configs/provider.md
@@ -0,0 +1,138 @@
+---
+article: ''
+date: ''
+title: ''
+updated: '2024-07-22T17:30:53.285+08:00'
+---
+# Service Provider Settings
+
+Qexo version 2.0 supports service provider extensions.
+
+|          | Github | Gitlab     | Local   |
+| -------- | ------ | ---------- | ------- |
+| Get File  | √      | No Size Data | √     |
+| Get Directory | √  | √         | √       |
+| Save File | √      | √          | √       |
+| Delete File | √    | √          | √       |
+| Webhook   | Automatic | Manual    | ×       |
+| Auto Deployment | Action | Action | Command Line |
+
+# Blog Software Settings
+
+Qexo version 2.6 and later supports multiple blog software (up to 2.6, Hexo, Hugo, and Valaxy are supported).
+
+## Using Github
+
+If you encounter issues during deployment, you can use the [HPP Validation Assistant](https://hexoplusplus.cronfly.workers.dev/?step=start) for configuration self-checks *only supports Github*. If everything is correct, check if there are any published articles in the repository.
+
+### Github Repository
+
+The repository where your blog source code **automatically deploys**
+
+```
+username/repo
+```
+
+References:
+
+- https://blog.cyfan.top/p/e626cb30.html
+- https://www.oplog.cn/archives/24998.html
+- https://crazywong.com/posts/74006f42
+
+### Project Branch
+
+The branch of your blog source code repository for automatic deployment
+
+```
+master
+```
+
+### Github Token
+
+Token generated at [Github Settings](https://github.com/settings/tokens) (Classical recommended)
+Requires permissions under Repo & Workflow *do not provide all permissions*
+
+```
+wrq_P8sYPlYA9fjMlOPEYSKA84xxxxxxxxxxxxxx
+```
+
+### Repository Path
+
+Path within your blog source code repository for automatic deployment. Leave empty if it is the root directory.
+
+```
+path/
+```
+
+## Using Gitlab
+
+### Gitlab Repository
+
+The repository where your blog source code **automatically deploys**
+
+```
+username/repo
+```
+
+References:
+
+- https://blog.cyfan.top/p/e626cb30.html
+- https://www.oplog.cn/archives/24998.html
+- https://crazywong.com/posts/74006f42
+
+### Project Branch
+
+The branch of your blog source code repository for automatic deployment
+
+```
+master
+```
+
+### Gitlab Token
+
+Token generated at [Gitlab Settings](https://gitlab.com/-/profile/personal_access_tokens)
+Requires at least read and write permissions under Repo *do not provide all permissions*
+
+```
+wrq_P8sYPlYA9fjMlOPEYSKA84xxxxxxxxxxxxxx
+```
+
+### Repository Path
+
+Path within your blog source code repository for automatic deployment. Leave empty if it is the root directory.
+
+```
+path/
+```
+
+## Using Local
+
+### Blog Path
+
+*Absolute path* where your blog source code is located locally
+
+```
+D:\Hexo
+```
+
+```
+/www/myblog
+```
+
+### Auto Deployment
+
+Command for automatic deployment, executed after each source code modification. Leave empty for no auto deployment.
+
+```bash
+hexo clean && hexo g && hexo d
+```
+
+```bash
+hugo
+```
+
+If you encounter `/bin/sh: 1: xxx: not found`, try adding `/bin/bash -c` before each command
+
+```bash
+/bin/bash -c "hexo clean" && /bin/bash -c "hexo g"
+```