feat：新增回乡真选分销文档

docs/hxzx/分销体系.md

@@ -0,0 +1,119 @@
+### 分销商分佣体系
+
+分销商按照上下级返佣，不考虑分享者
+
+举例说明：现有 4 个用户，上下级关系如下：
+
+**<font color="red">A -> B(分销商) -> C -> D -> E</font>**
+
+-   A 下单，他是 B 的上级，B 不会获得佣金
+
+-   B 下单，A 获得一级分佣，B 是下单者，同时是分销商，是分销商团队内的一员(**<font color="red">分销商团队内成员下单，分销商获得销售分成</font>**)，A 是 B 的上级，B 不会对他进行佣金抽成(**<font color="red">一级/二级获佣人是分销商成员时，分销商才对他们获得的佣金进行抽成</font>**)
+
+    因此这里 **A 获得一级返佣(不抽)，B 仅获得 销售分成**
+
+-   C 下单，A 获得二级返佣，B 获得一级返佣，C 是分销商团队内的一员，分销商 B 获得销售分成，B 也是分销商团队的一员，分销商对佣金进行抽成(PS:分销商和一/二级是同一人时，也会进行抽成，由于获佣者和抽成者是同一人因此获佣总额没变)，A 是 B 的的上级，不抽佣
+
+    因此这里 **A 获得二级返佣(不抽)，B 获得 销售分成 + 一级返佣(抽成后) + 二级返佣抽成**
+
+-   D 下单, B 获得二级返佣，C 获得一级返佣，D 是分销商团队内的一员，分销商 B 获得销售分成，B 和 C 都是分销商团队内的成员，B 对其进行抽佣
+
+    因此这里 **C 获得一级返佣(抽成后)，B 获得 销售分成 + 二级返佣(抽成后) + 二级返佣抽成 + 一级返佣抽成**
+
+-   E 下单，C 获得二级返佣，D 获得一级返佣，分销商 B 获得销售分成，C 和 D 都是分销商团队内的成员，B 对其进行抽佣
+
+    因此这里 **C 获得二级返佣(抽成后)，D 获得一级返佣(抽成后)，B 获得 销售分成 + 二级返佣抽成 + 一级返佣抽成**
+
+-   **PS1**：<font color="red">A -> B(分销商) -> C -> D(分销商) -> E -> F</font>
+
+    **当 D 成为分销商后，那么 B 分销团队就只有 B 和 C 两人，D、E、F 都会变更到 D 的分销团中**
+
+-   **PS2**：分销商的返佣抽成默认(商品不单独设置分销的情况下)按照 分销商 **<font color="red">团队佣金比例</font>** 设置的比例抽佣
+
+    ![image-20250527150132219](./image/%E5%88%86%E9%94%80%E4%BD%93%E7%B3%BB/image-20250527150132219.png)
+
+### 推广员分销体系
+
+1.  推广员：推广员分享商品，**其他人通过他的分享进入商品页并下单可以获取佣金，获佣逻辑无关分销上下级**，推广员可以通过小程序端商品详情页分销按钮进行推广，**推广员自己下单，不获得佣金，佣金将作为专属折扣，抵消一部分订单金额**
+    ![image-20250527151345632](./image/%E5%88%86%E9%94%80%E4%BD%93%E7%B3%BB/image-20250527151345632.png)
+
+2.  事业部：推广员是事业部的成员，创建事业部时，**关联用户**会成为该事业部的负责人/团长，事业部的**返佣比例**字段 用于限制团队中分销员的最大返佣比例，若这里为 10%，则在推广员页面中创建/修改该团队里的推广员的返佣比例不能超过 10%，**团队分成比例** 为事业部对 **推广员自购时的抽成**，比如：推广员自己下单 100 元的商品，则推广员专属折扣抵扣 9 元，事业部获得 1 元，因此推广员需要支付 91 元，**推广员邀请别人下单，事业部不进行抽成**，可以获得全额佣金 10 元
+
+    ![image-20250527151626159](./image/%E5%88%86%E9%94%80%E4%BD%93%E7%B3%BB/image-20250527151626159.png)
+
+-   PS1：事业部创建时关联的用户为团长，会自动在推广员页面中插入一条记录，并设置他的返佣比例为事业体中设置的返佣比例（最大比例）![image-20250527152654437](./image/%E5%88%86%E9%94%80%E4%BD%93%E7%B3%BB/image-20250527152654437.png)
+
+-   PS2：推广员可以在推广员管理页面中创建，也可以通过事业部团长邀请，邀请海报可以在事业体管理页中更改![image-20250527153803795](./image/%E5%88%86%E9%94%80%E4%BD%93%E7%B3%BB/image-20250527153803795.png)
+
+-   PS3：一个用户可以加入多个事业部，即一个用户可以有多个推广员身份，每个身份对应不同的事业部，在进行佣金计算时，会优先使用获佣最多/折扣最大的那个事业部，抽成也会被该事业部获取，举例说明：
+
+    -   用户 user1 加入了 A 和 B 两个事业部，A 给 user1 的返佣比例是 10%，自购时抽取 10%，B 给 user1 的返佣比例是 15%，自购时抽取 50%
+
+        -   当 推广员自购下单 100 元商品，使用 A 事业部推广员身份 抵扣 10 元 - 1 元 = 9 元，使用 B 事业部推广员身份 抵扣 15 元 - 7.5 元 = 7.5 元，系统会自动选择优惠最大的推广员身份，因此该笔订单将与 A 事业部挂钩
+        -   当 推广员邀请别人下单 100 元商品时，使用 A 事业部推广员身份 获得 10 元 佣金，使用 B 事业部推广员身份 获得 15 元 佣金，因此该笔订单将与 B 事业部挂钩
+
+### 分销配置
+
+![image-20250527160753690](./image/%E5%88%86%E9%94%80%E4%BD%93%E7%B3%BB/image-20250527160753690.png)
+
+-   **分销开关**：平台的分销总开关，关闭后所有订单不进行佣金处理
+
+-   **一级返佣比例**：一级分销员可以获得 邀请返佣的 百分之多少（分销商体系）
+
+-   **二级返佣比例**：二级分销员可以获得 邀请返佣的 百分之多少（分销商体系）
+
+-   **提现最低金额**：用户佣金提现的门槛
+
+-   **冻结时间**：订单确认收货/核销 后多久将佣金 打入用户佣金余额中，单位天，为 0 则立即入账
+
+### 商品分销设置
+
+![image-20250527160506728](./image/%E5%88%86%E9%94%80%E4%BD%93%E7%B3%BB/image-20250527160506728.png)
+
+**是否参与分销**：不参与则计算佣金时忽略该商品
+
+---
+
+![image-20250527160456683](./image/%E5%88%86%E9%94%80%E4%BD%93%E7%B3%BB/image-20250527160456683.png)
+
+**邀请返佣**：分销商体系中的配置，给一级分销和二级分销的返佣总数
+
+**销售分成**：分销商体系中的配置，分销商团队成员下单时，分销商获得的奖金
+
+PS：邀请返佣 + 销售分成 不能大于 商品售价
+
+---
+
+![image-20250527161303403](./image/%E5%88%86%E9%94%80%E4%BD%93%E7%B3%BB/image-20250527161303403.png)
+
+**默认比例：** 分销配置中设置的来
+
+---
+
+![image-20250527161404207](./image/%E5%88%86%E9%94%80%E4%BD%93%E7%B3%BB/image-20250527161404207.png)
+
+**单独设置**：指定一级二级各拿多少，但加起来不能超过前面设置的要求返佣
+
+---
+
+![image-20250527161446075](./image/%E5%88%86%E9%94%80%E4%BD%93%E7%B3%BB/image-20250527161446075.png)
+
+**分销商佣金默认设置**：销售分成按照前面设置的销售分成，抽成按照分销商中设置的团队分成进行抽取
+
+---
+
+![image-20250527161450524](./image/%E5%88%86%E9%94%80%E4%BD%93%E7%B3%BB/image-20250527161450524.png)
+
+**分销商佣金单独设置**：指定某些分销商的销售分成和团队抽成比例
+
+---
+
+![image-20250527161852090](./image/%E5%88%86%E9%94%80%E4%BD%93%E7%B3%BB/image-20250527161852090.png)
+
+**事业部内部价**：这里的 **内部价 **是 **返佣比例** 的另一种表现形式（固定金额），推广员自己下单 则 只需要支付内部价即可，推广员邀请普通用户下单时普通用户原价购买，**商品售价 - 内部价** 是推广员可以获得的佣金
+
+默认设置：按照推广员的返佣比例进行和事业部抽成进行计算
+
+![image-20250527155651610](./image/%E5%88%86%E9%94%80%E4%BD%93%E7%B3%BB/image-20250527155651610.png)
+
+单独设置：指定某些事业部统一的内部价和团队分成，此时 test1 所有成员买该商品 只需支付 20 元，test2 所有成员买该商品只需支付 15 元，同时加入 test1 和 test2 的用户 走 优惠更大的 test2 渠道

docusaurus.config.js

@@ -1,58 +1,58 @@
 // @ts-check
 // Note: type annotations allow type checking and IDEs autocompletion
 
-const lightCodeTheme = require('prism-react-renderer/themes/github');
-const darkCodeTheme = require('prism-react-renderer/themes/dracula');
+const lightCodeTheme = require("prism-react-renderer/themes/github");
+const darkCodeTheme = require("prism-react-renderer/themes/dracula");
 
 /** @type {import('@docusaurus/types').Config} */
 const config = {
-  title: '回乡文档',
+    title: "回乡文档",
     // tagline: 'power by 恐龙',
-  favicon: 'img/favicon.ico',
+    favicon: "img/favicon.ico",
 
     // Set the production url of your site here
-  url: 'https://docs.lotus-wallet.com',
+    url: "https://docs.lotus-wallet.com",
     // Set the /<baseUrl>/ pathname under which your site is served
     // For GitHub pages deployment, it is often '/<projectName>/'
-  baseUrl: '/',
+    baseUrl: "/",
 
     // GitHub pages deployment config.
     // If you aren't using GitHub pages, you don't need these.
-  organizationName: 'zsw', // Usually your GitHub org/user name.
-  projectName: 'zsw-docs', // Usually your repo name.
+    organizationName: "zsw", // Usually your GitHub org/user name.
+    projectName: "zsw-docs", // Usually your repo name.
 
-  onBrokenLinks: 'throw',
-  onBrokenMarkdownLinks: 'warn',
+    onBrokenLinks: "throw",
+    onBrokenMarkdownLinks: "warn",
 
     // Even if you don't use internalization, you can use this field to set useful
     // metadata like html lang. For example, if your site is Chinese, you may want
     // to replace "en" with "zh-Hans".
     i18n: {
-    defaultLocale: 'zh-Hans',
-    locales: ['zh-Hans'],
+        defaultLocale: "zh-Hans",
+        locales: ["zh-Hans"],
     },
 
     presets: [
         [
-      'classic',
+            "classic",
             /** @type {import('@docusaurus/preset-classic').Options} */
             ({
                 docs: {
-          sidebarPath: require.resolve('./sidebars.js'),
+                    sidebarPath: require.resolve("./sidebars.js"),
                     // Please change this to your repo.
                     // Remove this to remove the "edit this page" links.
                     editUrl:
-            'https://git.lotus-wallet.com/Loki/zsw-docs/src/branch/master',
+                        "https://git.lotus-wallet.com/Loki/zsw-docs/src/branch/master",
                 },
                 blog: {
                     showReadingTime: true,
                     // Please change this to your repo.
                     // Remove this to remove the "edit this page" links.
                     editUrl:
-            'https://git.lotus-wallet.com/Loki/zsw-docs/src/branch/master',
+                        "https://git.lotus-wallet.com/Loki/zsw-docs/src/branch/master",
                 },
                 theme: {
-          customCss: require.resolve('./src/css/custom.css'),
+                    customCss: require.resolve("./src/css/custom.css"),
                 },
             }),
         ],
@@ -62,116 +62,121 @@ const config = {
         /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
         ({
             // Replace with your project's social card
-      image: 'img/docusaurus-social-card.jpg',
+            image: "img/docusaurus-social-card.jpg",
             navbar: {
-        title: '回乡信息-软件使用文档',
+                title: "回乡信息-软件使用文档",
                 logo: {
-          alt: 'Log',
-          src: 'img/logo.svg',
+                    alt: "Log",
+                    src: "img/logo.svg",
                 },
                 items: [
                     {
-            type: 'docSidebar',
-            sidebarId: 'tenantSidebar',
-            position: 'left',
-            label: '回乡商家端',
+                        type: "docSidebar",
+                        sidebarId: "tenantSidebar",
+                        position: "left",
+                        label: "回乡商家端",
                     },
 
                     {
-            type: 'docSidebar',
-            sidebarId: 'appSidebar',
-            position: 'left',
-            label: '回乡App管理端',
+                        type: "docSidebar",
+                        sidebarId: "appSidebar",
+                        position: "left",
+                        label: "回乡App管理端",
                     },
 
                     {
-            type: 'docSidebar',
-            sidebarId: 'odooSidebar',
-            position: 'left',
-            label: 'Odoo操作指南',
+                        type: "docSidebar",
+                        sidebarId: "odooSidebar",
+                        position: "left",
+                        label: "Odoo操作指南",
                     },
 
                     {
-            type: 'docSidebar',
-            sidebarId: 'bxgSidebar',
-            position: 'left',
-            label: '一心回乡小程序',
+                        type: "docSidebar",
+                        sidebarId: "bxgSidebar",
+                        position: "left",
+                        label: "一心回乡小程序",
                     },
                     {
-            type: 'docSidebar',
-            sidebarId: 'bxgoSidebar',
-            position: 'left',
-            label: '宝象go',
+                        type: "docSidebar",
+                        sidebarId: "bxgoSidebar",
+                        position: "left",
+                        label: "宝象go",
                     },
                     {
-            type: 'docSidebar',
-            sidebarId: 'crmSidebar',
-            position: 'left',
-            label: '回乡管理系统',
+                        type: "docSidebar",
+                        sidebarId: "crmSidebar",
+                        position: "left",
+                        label: "回乡管理系统",
                     },
                     {
-            type: 'docSidebar',
-            sidebarId: 'erpSidebar',
-            position: 'left',
-            label: '回乡ERP管理系统',
+                        type: "docSidebar",
+                        sidebarId: "erpSidebar",
+                        position: "left",
+                        label: "回乡ERP管理系统",
+                    },
+                    {
+                        type: "docSidebar",
+                        sidebarId: "hxzxSidebar",
+                        position: "left",
+                        label: "回乡真选",
                     },
-
 
                     // {to: '/blog', label: 'Blog', position: 'left'},
                     {
-            href: 'http://www.yixinhuixiang.com',
-            label: '一心回乡',
-            position: 'right',
+                        href: "http://www.yixinhuixiang.com",
+                        label: "一心回乡",
+                        position: "right",
                     },
                 ],
             },
             footer: {
-        style: 'dark',
+                style: "dark",
                 links: [
                     {
-            title: '帮助',
+                        title: "帮助",
                         items: [
                             {
-                label: '回乡门店',
-                to: '/docs/zsw/intro',
+                                label: "回乡门店",
+                                to: "/docs/zsw/intro",
                             },
                             {
-                label: '回乡APP',
-                to: '/docs/app/start',
+                                label: "回乡APP",
+                                to: "/docs/app/start",
                             },
                             {
-                label: 'Odoo',
-                to: '/docs/odoo/start',
+                                label: "Odoo",
+                                to: "/docs/odoo/start",
                             },
                         ],
                     },
                     {
-            title: '链接',
+                        title: "链接",
                         items: [
                             {
-                label: '商家端',
-                href: 'https://pos.tenant.lotus-wallet.com',
+                                label: "商家端",
+                                href: "https://pos.tenant.lotus-wallet.com",
                             },
                             {
-                label: '门店端',
-                href: 'https://pos.merchant.lotus-wallet.com',
+                                label: "门店端",
+                                href: "https://pos.merchant.lotus-wallet.com",
                             },
                             {
-                label: '平台端',
-                href: 'https://pos.admin.lotus-wallet.com',
+                                label: "平台端",
+                                href: "https://pos.admin.lotus-wallet.com",
                             },
                         ],
                     },
                     {
-            title: '更多',
+                        title: "更多",
                         items: [
                             {
-                label: 'Blog',
-                to: '/blog',
+                                label: "Blog",
+                                to: "/blog",
                             },
                             {
-                label: '回乡',
-                href: 'https://www.yixinhuixiang.com',
+                                label: "回乡",
+                                href: "https://www.yixinhuixiang.com",
                             },
                         ],
                     },

package.json

@@ -36,8 +36,5 @@
             "last 1 firefox version",
             "last 1 safari version"
         ]
-  },
-  "engines": {
-    "node": ">=16.14"
     }
 }

sidebars.js

@@ -13,47 +13,52 @@
 
 /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
 const sidebars = {
-
     tenantSidebar: [
         {
-      type: 'autogenerated',
-      dirName: 'zsw'
+            type: "autogenerated",
+            dirName: "zsw",
         },
     ],
     appSidebar: [
         {
-      type: 'autogenerated',
-      dirName: 'app',
+            type: "autogenerated",
+            dirName: "app",
         },
     ],
     odooSidebar: [
         {
-      type: 'autogenerated',
-      dirName: 'odoo',
+            type: "autogenerated",
+            dirName: "odoo",
         },
     ],
     bxgSidebar: [
         {
-      type: 'autogenerated',
-      dirName: 'bxg',
+            type: "autogenerated",
+            dirName: "bxg",
         },
     ],
     bxgoSidebar: [
         {
-      type: 'autogenerated',
-      dirName: 'bxgo',
+            type: "autogenerated",
+            dirName: "bxgo",
         },
     ],
     crmSidebar: [
         {
-      type: 'autogenerated',
-      dirName: 'crm',
+            type: "autogenerated",
+            dirName: "crm",
         },
     ],
     erpSidebar: [
         {
-      type: 'autogenerated',
-      dirName: 'erp',
+            type: "autogenerated",
+            dirName: "erp",
+        },
+    ],
+    hxzxSidebar: [
+        {
+            type: "autogenerated",
+            dirName: "hxzx",
         },
     ],
 };