From ac951c54cd8cc12f75b59ead5b2ce0810c160a1b Mon Sep 17 00:00:00 2001 From: kathy <2900360580@qq.com> Date: Thu, 21 Sep 2023 08:21:30 +0800 Subject: [PATCH 1/5] =?UTF-8?q?=E5=A2=9E=E5=8A=A0=E7=9B=AE=E5=BD=95?= =?UTF-8?q?=EF=BC=8C=E8=B0=83=E6=95=B4=E6=96=87=E4=BB=B6=E7=BB=93=E6=9E=84?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/.vuepress/config.js | 22 +++++++++------ docs/README-en.md | 27 +++++++++++++++++++ docs/README.md | 26 +++++++++++------- docs/en/README.md | 27 +++++++++++++++++++ docs/en/dynamic-webapi/index.md | 1 + docs/{ => en}/guide/README.md | 0 docs/{ => en}/guide/lab.md | 0 docs/{ => en}/guide/mp/Advanced.md | 0 docs/{ => en}/guide/mp/AdvancedInterface.md | 0 docs/{ => en}/guide/mp/JSSDK.md | 0 docs/{ => en}/guide/mp/MenuSetup.md | 0 docs/{ => en}/guide/mp/MessageHandler.md | 0 docs/{ => en}/guide/mp/OAuth2.0.md | 0 docs/{ => en}/guide/mp/install.md | 0 docs/{ => en}/guide/mp/registration.md | 0 docs/{ => en}/guide/mp/source_code.md | 0 docs/{ => en}/guide/release/log.md | 0 docs/{ => en}/guide/release/new_function.md | 0 docs/{ => en}/guide/tenpayv2/Advanced.md | 0 docs/{ => en}/guide/tenpayv2/JASPI_Payment.md | 0 .../{ => en}/guide/tenpayv2/Native_Payment.md | 0 .../guide/tenpayv2/Payment_callbacks.md | 0 docs/{ => en}/guide/tenpayv2/Refunds.md | 0 docs/{ => en}/guide/tenpayv2/Registration.md | 0 docs/{ => en}/guide/tenpayv2/Source_code.md | 0 docs/{ => en}/guide/tenpayv2/install.md | 0 docs/{ => en}/guide/tenpayv3/Advanced.md | 0 docs/{ => en}/guide/tenpayv3/JASPI.md | 0 .../guide/tenpayv3/Native_Payments.md | 0 .../guide/tenpayv3/Payment_callbacks.md | 0 docs/{ => en}/guide/tenpayv3/Refunds.md | 0 docs/{ => en}/guide/tenpayv3/Registration.md | 0 docs/{ => en}/guide/tenpayv3/Source_code.md | 0 docs/{ => en}/guide/tenpayv3/install.md | 0 docs/{ => en}/guide/work/Advanced.md | 0 .../{ => en}/guide/work/Advanced_Interface.md | 0 docs/{ => en}/guide/work/JSSDK_General.md | 0 docs/{ => en}/guide/work/JSSDK_agentConfig.md | 0 docs/{ => en}/guide/work/MenuSetting.md | 0 docs/{ => en}/guide/work/MessageHandler.md | 0 docs/{ => en}/guide/work/OAuth2.0.md | 0 docs/{ => en}/guide/work/Registration.md | 0 docs/{ => en}/guide/work/Source_code.md | 0 docs/{ => en}/guide/work/install.md | 0 docs/{ => en}/guide/wxopen/Advanced.md | 0 .../guide/wxopen/Advanced_Interface.md | 0 .../guide/wxopen/Applet_Request_Service.md | 0 .../guide/wxopen/Client_Development.md | 0 .../{ => en}/guide/wxopen/Get_phone_number.md | 0 docs/{ => en}/guide/wxopen/MessageHandler.md | 0 docs/{ => en}/guide/wxopen/Other.md | 0 docs/{ => en}/guide/wxopen/Registration.md | 0 docs/{ => en}/guide/wxopen/Sign_in.md | 0 docs/{ => en}/guide/wxopen/Source_code.md | 0 docs/{ => en}/guide/wxopen/install.md | 0 docs/zh/README.md | 20 +++++++++----- package.json | 2 +- 57 files changed, 101 insertions(+), 24 deletions(-) create mode 100644 docs/README-en.md create mode 100644 docs/en/README.md create mode 100644 docs/en/dynamic-webapi/index.md rename docs/{ => en}/guide/README.md (100%) rename docs/{ => en}/guide/lab.md (100%) rename docs/{ => en}/guide/mp/Advanced.md (100%) rename docs/{ => en}/guide/mp/AdvancedInterface.md (100%) rename docs/{ => en}/guide/mp/JSSDK.md (100%) rename docs/{ => en}/guide/mp/MenuSetup.md (100%) rename docs/{ => en}/guide/mp/MessageHandler.md (100%) rename docs/{ => en}/guide/mp/OAuth2.0.md (100%) rename docs/{ => en}/guide/mp/install.md (100%) rename docs/{ => en}/guide/mp/registration.md (100%) rename docs/{ => en}/guide/mp/source_code.md (100%) rename docs/{ => en}/guide/release/log.md (100%) rename docs/{ => en}/guide/release/new_function.md (100%) rename docs/{ => en}/guide/tenpayv2/Advanced.md (100%) rename docs/{ => en}/guide/tenpayv2/JASPI_Payment.md (100%) rename docs/{ => en}/guide/tenpayv2/Native_Payment.md (100%) rename docs/{ => en}/guide/tenpayv2/Payment_callbacks.md (100%) rename docs/{ => en}/guide/tenpayv2/Refunds.md (100%) rename docs/{ => en}/guide/tenpayv2/Registration.md (100%) rename docs/{ => en}/guide/tenpayv2/Source_code.md (100%) rename docs/{ => en}/guide/tenpayv2/install.md (100%) rename docs/{ => en}/guide/tenpayv3/Advanced.md (100%) rename docs/{ => en}/guide/tenpayv3/JASPI.md (100%) rename docs/{ => en}/guide/tenpayv3/Native_Payments.md (100%) rename docs/{ => en}/guide/tenpayv3/Payment_callbacks.md (100%) rename docs/{ => en}/guide/tenpayv3/Refunds.md (100%) rename docs/{ => en}/guide/tenpayv3/Registration.md (100%) rename docs/{ => en}/guide/tenpayv3/Source_code.md (100%) rename docs/{ => en}/guide/tenpayv3/install.md (100%) rename docs/{ => en}/guide/work/Advanced.md (100%) rename docs/{ => en}/guide/work/Advanced_Interface.md (100%) rename docs/{ => en}/guide/work/JSSDK_General.md (100%) rename docs/{ => en}/guide/work/JSSDK_agentConfig.md (100%) rename docs/{ => en}/guide/work/MenuSetting.md (100%) rename docs/{ => en}/guide/work/MessageHandler.md (100%) rename docs/{ => en}/guide/work/OAuth2.0.md (100%) rename docs/{ => en}/guide/work/Registration.md (100%) rename docs/{ => en}/guide/work/Source_code.md (100%) rename docs/{ => en}/guide/work/install.md (100%) rename docs/{ => en}/guide/wxopen/Advanced.md (100%) rename docs/{ => en}/guide/wxopen/Advanced_Interface.md (100%) rename docs/{ => en}/guide/wxopen/Applet_Request_Service.md (100%) rename docs/{ => en}/guide/wxopen/Client_Development.md (100%) rename docs/{ => en}/guide/wxopen/Get_phone_number.md (100%) rename docs/{ => en}/guide/wxopen/MessageHandler.md (100%) rename docs/{ => en}/guide/wxopen/Other.md (100%) rename docs/{ => en}/guide/wxopen/Registration.md (100%) rename docs/{ => en}/guide/wxopen/Sign_in.md (100%) rename docs/{ => en}/guide/wxopen/Source_code.md (100%) rename docs/{ => en}/guide/wxopen/install.md (100%) diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index e3fd1f04cd..62157536b8 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -1,11 +1,12 @@ module.exports = { - base: "/docs/", + base: "/docs/zh/", + lang: "zh-CN", head: [ ["link", { rel: "shortcut icon", type: "image/x-icon", href: "/icon.jpg" }], ["script", {}, ``], ], locales: { - "/": { + "/en/": { lang: "en-US", title: "Wechat.NET SDK", description: @@ -20,6 +21,8 @@ module.exports = { }, // evergreen: true, port: 8080, + host: "localhost", + open: true, plugins: ["@vuepress/back-to-top"], themeConfig: { repo: "JeffreySu/WeiXinMPSDK", @@ -40,7 +43,7 @@ module.exports = { // 默认为 "Edit this page" // editLinkText: '帮助我们改善此页面！', locales: { - "/": { + "/en/": { label: "English", repoLabel: "Github", selectText: "Languages", @@ -48,14 +51,14 @@ module.exports = { editLinkText: "Edit this page on GitHub", lastUpdated: "Last Updated", nav: [ - { text: "Guide", link: "/guide/" }, + { text: "Guide", link: "/en/guide/" }, { text: "Ecosystem", items: [ { text: "Project", items: [ - { text: "Dynamic WebApi", link: "/dynamic-webapi/index" }, + { text: "Dynamic WebApi", link: "/en/dynamic-webapi/index" }, ], }, { @@ -78,7 +81,7 @@ module.exports = { { text: "Gitee", link: "https://gitee.com/JeffreySu/WeiXinMPSDK" }, ], sidebar: { - "/guide/": [ + "/en/guide/": [ { title: "Guide", collapsable: false, @@ -163,10 +166,13 @@ module.exports = { { title: "Newly Release", collapsable: false, - children: ["/guide/release/new_function", "/guide/release/log"], + children: [ + "/en/guide/release/new_function", + "/en/guide/release/log", + ], }, ], - "/dynamic-webapi/": [ + "/en/dynamic-webapi/": [ { title: "Dynamic WebApi", collapsable: false, diff --git a/docs/README-en.md b/docs/README-en.md new file mode 100644 index 0000000000..a005ef126b --- /dev/null +++ b/docs/README-en.md @@ -0,0 +1,27 @@ +--- +home: true +heroImage: /icon.jpg +heroText: JeffreySu/WeiXinMPSDK +tagline: Easily build extended apps for all wechat platforms +actionText: Get Started → +actionLink: /en/guide/ +features: + - title: Wide Application + details: Senparc.Weixin SDK with the highest usage rate at present. + - title: Multi-Platform + details: MP、WxOpen、Tenpay V2/V3、JS-SDK、Open、Work…… + - title: Scalability + details: Senparc.Weixin SDK Extension components are used to provide a series of extension modules such as cache and WebSocket. +--- + +| Document catalogue | Description | +| ------------------------------------ | ---------------------- | +| [en/guide/MP](guide/MP/) | MP Documentation | +| [en/guide/TenPayV2](guide/TenPayV2/) | TenPayV2 Documentation | +| [en/guide/TenPayV3](guide/TenPayV3/) | TenPayV3 Documentation | +| [en/guide/Work](guide/Work/) | Work Documentation | +| [en/guide/WxOpen](guide/WxOpen/) | WxOpen Documentation | + +::: slot footer +Apache License Version 2.0 | Copyright © 2006-present [JeffreySu/WeiXinMPSDK](https://github.com/JeffreySu/WeiXinMPSDK) +::: diff --git a/docs/README.md b/docs/README.md index 8a7d57c260..2583afa6a6 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,18 +2,26 @@ home: true heroImage: /icon.jpg heroText: JeffreySu/WeiXinMPSDK -tagline: Easily build extended apps for all wechat platforms -actionText: Get Started → -actionLink: /guide/ +tagline: 轻松打造微信各平台的扩展应用 +actionText: 快速上手 → +actionLink: /zh/guide/ features: -- title: Wide Application - details: Senparc.Weixin SDK with the highest usage rate at present. -- title: Multi-Platform - details: MP、WxOpen、Tenpay V2/V3、JS-SDK、Open、Work…… -- title: Scalability - details: Senparc.Weixin SDK Extension components are used to provide a series of extension modules such as cache and WebSocket. + - title: 应用广泛 + details: 目前使用率最高的微信 .NET SDK。 + - title: 多平台 + details: 微信公众号、小程序、微信支付V2/V3、JS-SDK、开放平台、企业号、企业微信…… + - title: 可扩展 + details: Senparc.Weixin SDK 扩展组件用于提供缓存、WebSocket 等一系列扩展模块。 --- +| 中文文档目录 | 说明 | +| -------------------------------------------- | ---------------- | +| [docs/zh/guide/MP](zh/guide/MP/) | 公众号模块文档 | +| [docs/zh/guide/TenPayV2](zh/guide/TenPayV2/) | 微信支付 V2 文档 | +| [docs/zh/guide/TenPayV3](zh/guide/TenPayV3/) | 微信支付 V3 文档 | +| [docs/zh/guide/Work](zh/guide/Work/) | 企业微信文档 | +| [docs/zh/guide/WxOpen](zh/guide/WxOpen/) | 小程序文档 | + ::: slot footer Apache License Version 2.0 | Copyright © 2006-present [JeffreySu/WeiXinMPSDK](https://github.com/JeffreySu/WeiXinMPSDK) ::: diff --git a/docs/en/README.md b/docs/en/README.md new file mode 100644 index 0000000000..b5a2a2f6c8 --- /dev/null +++ b/docs/en/README.md @@ -0,0 +1,27 @@ +--- +home: true +heroImage: /icon.jpg +heroText: JeffreySu/WeiXinMPSDK +tagline: Easily build extended apps for all wechat platforms +actionText: Get Started → +actionLink: /en/guide/ +features: + - title: Wide Application + details: Senparc.Weixin SDK with the highest usage rate at present. + - title: Multi-Platform + details: MP、WxOpen、Tenpay V2/V3、JS-SDK、Open、Work…… + - title: Scalability + details: Senparc.Weixin SDK Extension components are used to provide a series of extension modules such as cache and WebSocket. +--- + +| Document catalogue | Description | +| --------------------------------- | ---------------------- | +| [guide/MP](guide/MP/) | MP Documentation | +| [guide/TenPayV2](guide/TenPayV2/) | TenPayV2 Documentation | +| [guide/TenPayV3](guide/TenPayV3/) | TenPayV3 Documentation | +| [guide/Work](guide/Work/) | Work Documentation | +| [guide/WxOpen](guide/WxOpen/) | WxOpen Documentation | + +::: slot footer +Apache License Version 2.0 | Copyright © 2006-present [JeffreySu/WeiXinMPSDK](https://github.com/JeffreySu/WeiXinMPSDK) +::: diff --git a/docs/en/dynamic-webapi/index.md b/docs/en/dynamic-webapi/index.md new file mode 100644 index 0000000000..830b2c9156 --- /dev/null +++ b/docs/en/dynamic-webapi/index.md @@ -0,0 +1 @@ +# Dynamic WebApi diff --git a/docs/guide/README.md b/docs/en/guide/README.md similarity index 100% rename from docs/guide/README.md rename to docs/en/guide/README.md diff --git a/docs/guide/lab.md b/docs/en/guide/lab.md similarity index 100% rename from docs/guide/lab.md rename to docs/en/guide/lab.md diff --git a/docs/guide/mp/Advanced.md b/docs/en/guide/mp/Advanced.md similarity index 100% rename from docs/guide/mp/Advanced.md rename to docs/en/guide/mp/Advanced.md diff --git a/docs/guide/mp/AdvancedInterface.md b/docs/en/guide/mp/AdvancedInterface.md similarity index 100% rename from docs/guide/mp/AdvancedInterface.md rename to docs/en/guide/mp/AdvancedInterface.md diff --git a/docs/guide/mp/JSSDK.md b/docs/en/guide/mp/JSSDK.md similarity index 100% rename from docs/guide/mp/JSSDK.md rename to docs/en/guide/mp/JSSDK.md diff --git a/docs/guide/mp/MenuSetup.md b/docs/en/guide/mp/MenuSetup.md similarity index 100% rename from docs/guide/mp/MenuSetup.md rename to docs/en/guide/mp/MenuSetup.md diff --git a/docs/guide/mp/MessageHandler.md b/docs/en/guide/mp/MessageHandler.md similarity index 100% rename from docs/guide/mp/MessageHandler.md rename to docs/en/guide/mp/MessageHandler.md diff --git a/docs/guide/mp/OAuth2.0.md b/docs/en/guide/mp/OAuth2.0.md similarity index 100% rename from docs/guide/mp/OAuth2.0.md rename to docs/en/guide/mp/OAuth2.0.md diff --git a/docs/guide/mp/install.md b/docs/en/guide/mp/install.md similarity index 100% rename from docs/guide/mp/install.md rename to docs/en/guide/mp/install.md diff --git a/docs/guide/mp/registration.md b/docs/en/guide/mp/registration.md similarity index 100% rename from docs/guide/mp/registration.md rename to docs/en/guide/mp/registration.md diff --git a/docs/guide/mp/source_code.md b/docs/en/guide/mp/source_code.md similarity index 100% rename from docs/guide/mp/source_code.md rename to docs/en/guide/mp/source_code.md diff --git a/docs/guide/release/log.md b/docs/en/guide/release/log.md similarity index 100% rename from docs/guide/release/log.md rename to docs/en/guide/release/log.md diff --git a/docs/guide/release/new_function.md b/docs/en/guide/release/new_function.md similarity index 100% rename from docs/guide/release/new_function.md rename to docs/en/guide/release/new_function.md diff --git a/docs/guide/tenpayv2/Advanced.md b/docs/en/guide/tenpayv2/Advanced.md similarity index 100% rename from docs/guide/tenpayv2/Advanced.md rename to docs/en/guide/tenpayv2/Advanced.md diff --git a/docs/guide/tenpayv2/JASPI_Payment.md b/docs/en/guide/tenpayv2/JASPI_Payment.md similarity index 100% rename from docs/guide/tenpayv2/JASPI_Payment.md rename to docs/en/guide/tenpayv2/JASPI_Payment.md diff --git a/docs/guide/tenpayv2/Native_Payment.md b/docs/en/guide/tenpayv2/Native_Payment.md similarity index 100% rename from docs/guide/tenpayv2/Native_Payment.md rename to docs/en/guide/tenpayv2/Native_Payment.md diff --git a/docs/guide/tenpayv2/Payment_callbacks.md b/docs/en/guide/tenpayv2/Payment_callbacks.md similarity index 100% rename from docs/guide/tenpayv2/Payment_callbacks.md rename to docs/en/guide/tenpayv2/Payment_callbacks.md diff --git a/docs/guide/tenpayv2/Refunds.md b/docs/en/guide/tenpayv2/Refunds.md similarity index 100% rename from docs/guide/tenpayv2/Refunds.md rename to docs/en/guide/tenpayv2/Refunds.md diff --git a/docs/guide/tenpayv2/Registration.md b/docs/en/guide/tenpayv2/Registration.md similarity index 100% rename from docs/guide/tenpayv2/Registration.md rename to docs/en/guide/tenpayv2/Registration.md diff --git a/docs/guide/tenpayv2/Source_code.md b/docs/en/guide/tenpayv2/Source_code.md similarity index 100% rename from docs/guide/tenpayv2/Source_code.md rename to docs/en/guide/tenpayv2/Source_code.md diff --git a/docs/guide/tenpayv2/install.md b/docs/en/guide/tenpayv2/install.md similarity index 100% rename from docs/guide/tenpayv2/install.md rename to docs/en/guide/tenpayv2/install.md diff --git a/docs/guide/tenpayv3/Advanced.md b/docs/en/guide/tenpayv3/Advanced.md similarity index 100% rename from docs/guide/tenpayv3/Advanced.md rename to docs/en/guide/tenpayv3/Advanced.md diff --git a/docs/guide/tenpayv3/JASPI.md b/docs/en/guide/tenpayv3/JASPI.md similarity index 100% rename from docs/guide/tenpayv3/JASPI.md rename to docs/en/guide/tenpayv3/JASPI.md diff --git a/docs/guide/tenpayv3/Native_Payments.md b/docs/en/guide/tenpayv3/Native_Payments.md similarity index 100% rename from docs/guide/tenpayv3/Native_Payments.md rename to docs/en/guide/tenpayv3/Native_Payments.md diff --git a/docs/guide/tenpayv3/Payment_callbacks.md b/docs/en/guide/tenpayv3/Payment_callbacks.md similarity index 100% rename from docs/guide/tenpayv3/Payment_callbacks.md rename to docs/en/guide/tenpayv3/Payment_callbacks.md diff --git a/docs/guide/tenpayv3/Refunds.md b/docs/en/guide/tenpayv3/Refunds.md similarity index 100% rename from docs/guide/tenpayv3/Refunds.md rename to docs/en/guide/tenpayv3/Refunds.md diff --git a/docs/guide/tenpayv3/Registration.md b/docs/en/guide/tenpayv3/Registration.md similarity index 100% rename from docs/guide/tenpayv3/Registration.md rename to docs/en/guide/tenpayv3/Registration.md diff --git a/docs/guide/tenpayv3/Source_code.md b/docs/en/guide/tenpayv3/Source_code.md similarity index 100% rename from docs/guide/tenpayv3/Source_code.md rename to docs/en/guide/tenpayv3/Source_code.md diff --git a/docs/guide/tenpayv3/install.md b/docs/en/guide/tenpayv3/install.md similarity index 100% rename from docs/guide/tenpayv3/install.md rename to docs/en/guide/tenpayv3/install.md diff --git a/docs/guide/work/Advanced.md b/docs/en/guide/work/Advanced.md similarity index 100% rename from docs/guide/work/Advanced.md rename to docs/en/guide/work/Advanced.md diff --git a/docs/guide/work/Advanced_Interface.md b/docs/en/guide/work/Advanced_Interface.md similarity index 100% rename from docs/guide/work/Advanced_Interface.md rename to docs/en/guide/work/Advanced_Interface.md diff --git a/docs/guide/work/JSSDK_General.md b/docs/en/guide/work/JSSDK_General.md similarity index 100% rename from docs/guide/work/JSSDK_General.md rename to docs/en/guide/work/JSSDK_General.md diff --git a/docs/guide/work/JSSDK_agentConfig.md b/docs/en/guide/work/JSSDK_agentConfig.md similarity index 100% rename from docs/guide/work/JSSDK_agentConfig.md rename to docs/en/guide/work/JSSDK_agentConfig.md diff --git a/docs/guide/work/MenuSetting.md b/docs/en/guide/work/MenuSetting.md similarity index 100% rename from docs/guide/work/MenuSetting.md rename to docs/en/guide/work/MenuSetting.md diff --git a/docs/guide/work/MessageHandler.md b/docs/en/guide/work/MessageHandler.md similarity index 100% rename from docs/guide/work/MessageHandler.md rename to docs/en/guide/work/MessageHandler.md diff --git a/docs/guide/work/OAuth2.0.md b/docs/en/guide/work/OAuth2.0.md similarity index 100% rename from docs/guide/work/OAuth2.0.md rename to docs/en/guide/work/OAuth2.0.md diff --git a/docs/guide/work/Registration.md b/docs/en/guide/work/Registration.md similarity index 100% rename from docs/guide/work/Registration.md rename to docs/en/guide/work/Registration.md diff --git a/docs/guide/work/Source_code.md b/docs/en/guide/work/Source_code.md similarity index 100% rename from docs/guide/work/Source_code.md rename to docs/en/guide/work/Source_code.md diff --git a/docs/guide/work/install.md b/docs/en/guide/work/install.md similarity index 100% rename from docs/guide/work/install.md rename to docs/en/guide/work/install.md diff --git a/docs/guide/wxopen/Advanced.md b/docs/en/guide/wxopen/Advanced.md similarity index 100% rename from docs/guide/wxopen/Advanced.md rename to docs/en/guide/wxopen/Advanced.md diff --git a/docs/guide/wxopen/Advanced_Interface.md b/docs/en/guide/wxopen/Advanced_Interface.md similarity index 100% rename from docs/guide/wxopen/Advanced_Interface.md rename to docs/en/guide/wxopen/Advanced_Interface.md diff --git a/docs/guide/wxopen/Applet_Request_Service.md b/docs/en/guide/wxopen/Applet_Request_Service.md similarity index 100% rename from docs/guide/wxopen/Applet_Request_Service.md rename to docs/en/guide/wxopen/Applet_Request_Service.md diff --git a/docs/guide/wxopen/Client_Development.md b/docs/en/guide/wxopen/Client_Development.md similarity index 100% rename from docs/guide/wxopen/Client_Development.md rename to docs/en/guide/wxopen/Client_Development.md diff --git a/docs/guide/wxopen/Get_phone_number.md b/docs/en/guide/wxopen/Get_phone_number.md similarity index 100% rename from docs/guide/wxopen/Get_phone_number.md rename to docs/en/guide/wxopen/Get_phone_number.md diff --git a/docs/guide/wxopen/MessageHandler.md b/docs/en/guide/wxopen/MessageHandler.md similarity index 100% rename from docs/guide/wxopen/MessageHandler.md rename to docs/en/guide/wxopen/MessageHandler.md diff --git a/docs/guide/wxopen/Other.md b/docs/en/guide/wxopen/Other.md similarity index 100% rename from docs/guide/wxopen/Other.md rename to docs/en/guide/wxopen/Other.md diff --git a/docs/guide/wxopen/Registration.md b/docs/en/guide/wxopen/Registration.md similarity index 100% rename from docs/guide/wxopen/Registration.md rename to docs/en/guide/wxopen/Registration.md diff --git a/docs/guide/wxopen/Sign_in.md b/docs/en/guide/wxopen/Sign_in.md similarity index 100% rename from docs/guide/wxopen/Sign_in.md rename to docs/en/guide/wxopen/Sign_in.md diff --git a/docs/guide/wxopen/Source_code.md b/docs/en/guide/wxopen/Source_code.md similarity index 100% rename from docs/guide/wxopen/Source_code.md rename to docs/en/guide/wxopen/Source_code.md diff --git a/docs/guide/wxopen/install.md b/docs/en/guide/wxopen/install.md similarity index 100% rename from docs/guide/wxopen/install.md rename to docs/en/guide/wxopen/install.md diff --git a/docs/zh/README.md b/docs/zh/README.md index 71a909af89..0546cea3c1 100644 --- a/docs/zh/README.md +++ b/docs/zh/README.md @@ -6,14 +6,22 @@ tagline: 轻松打造微信各平台的扩展应用 actionText: 快速上手 → actionLink: /zh/guide/ features: -- title: 应用广泛 - details: 目前使用率最高的微信 .NET SDK。 -- title: 多平台 - details: 微信公众号、小程序、微信支付V2/V3、JS-SDK、开放平台、企业号、企业微信…… -- title: 可扩展 - details: Senparc.Weixin SDK 扩展组件用于提供缓存、WebSocket 等一系列扩展模块。 + - title: 应用广泛 + details: 目前使用率最高的微信 .NET SDK。 + - title: 多平台 + details: 微信公众号、小程序、微信支付V2/V3、JS-SDK、开放平台、企业号、企业微信…… + - title: 可扩展 + details: Senparc.Weixin SDK 扩展组件用于提供缓存、WebSocket 等一系列扩展模块。 --- +| 中文文档目录 | 说明 | +| --------------------------------- | ---------------- | +| [guide/MP](guide/MP/) | 公众号模块文档 | +| [guide/TenPayV2](guide/TenPayV2/) | 微信支付 V2 文档 | +| [guide/TenPayV3](guide/TenPayV3/) | 微信支付 V3 文档 | +| [guide/Work](guide/Work/) | 企业微信文档 | +| [guide/WxOpen](guide/WxOpen/) | 小程序文档 | + ::: slot footer Apache License Version 2.0 | Copyright © 2006-present [JeffreySu/WeiXinMPSDK](https://github.com/JeffreySu/WeiXinMPSDK) ::: diff --git a/package.json b/package.json index a4b9c1fbf3..3df7e270c7 100644 --- a/package.json +++ b/package.json @@ -11,7 +11,7 @@ "vuepress": "^1.9.9" }, "scripts": { - "docs:dev": "vuepress dev docs", + "docs:dev": "vuepress dev docs --host localhost --open true", "docs:build": "vuepress build docs" } } From 8099e60139ecfbdf061f498cf06fcf17c75f5094 Mon Sep 17 00:00:00 2001 From: JeffreySu Date: Mon, 9 Oct 2023 01:09:09 +0800 Subject: [PATCH 2/5] modify --- .../Properties/launchSettings.json | 26 +++++++++---------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/Samples/Work/Senparc.Weixin.Sample.Work/Properties/launchSettings.json b/Samples/Work/Senparc.Weixin.Sample.Work/Properties/launchSettings.json index fbad8c9c47..b7c214b18e 100644 --- a/Samples/Work/Senparc.Weixin.Sample.Work/Properties/launchSettings.json +++ b/Samples/Work/Senparc.Weixin.Sample.Work/Properties/launchSettings.json @@ -1,21 +1,13 @@ -{ - "iisSettings": { - "windowsAuthentication": false, - "anonymousAuthentication": true, - "iisExpress": { - "applicationUrl": "http://localhost:17966", - "sslPort": 44366 - } - }, +{ "profiles": { "Senparc.Weixin.Sample.Work": { "commandName": "Project", - "dotnetRunMessages": true, "launchBrowser": true, - "applicationUrl": "https://localhost:7066;http://localhost:5066", "environmentVariables": { "ASPNETCORE_ENVIRONMENT": "Development" - } + }, + "dotnetRunMessages": true, + "applicationUrl": "https://localhost:7066;http://localhost:5066" }, "IIS Express": { "commandName": "IISExpress", @@ -24,5 +16,13 @@ "ASPNETCORE_ENVIRONMENT": "Development" } } + }, + "iisSettings": { + "windowsAuthentication": false, + "anonymousAuthentication": true, + "iisExpress": { + "applicationUrl": "http://localhost:61043/", + "sslPort": 44325 + } } -} +} \ No newline at end of file From da135003cb8c7e6284b2c3e9d632dbe8fe6c6e62 Mon Sep 17 00:00:00 2001 From: JeffreySu Date: Mon, 9 Oct 2023 01:11:37 +0800 Subject: [PATCH 3/5] =?UTF-8?q?WxOpen=20v3.16.4=20=E5=BE=AE=E4=BF=A1?= =?UTF-8?q?=E5=B7=B2=E4=BA=8E2023=20=E5=B9=B4=209=20=E6=9C=88=2020=20?= =?UTF-8?q?=E6=97=A5=E6=94=B6=E5=9B=9E=E4=B8=8B=E5=8F=91=E7=BB=9F=E4=B8=80?= =?UTF-8?q?=E6=B6=88=E6=81=AF=E6=8E=A5=E5=8F=A3=EF=BC=8C=E6=A0=87=E6=B3=A8?= =?UTF-8?q?=E8=BF=87=E6=97=B6=20#2921=20=E6=84=9F=E8=B0=A2=20@lishewen?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../Senparc.Weixin.WxOpen/Senparc.Weixin.WxOpen.net7.csproj | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/Senparc.Weixin.WxOpen/src/Senparc.Weixin.WxOpen/Senparc.Weixin.WxOpen/Senparc.Weixin.WxOpen.net7.csproj b/src/Senparc.Weixin.WxOpen/src/Senparc.Weixin.WxOpen/Senparc.Weixin.WxOpen/Senparc.Weixin.WxOpen.net7.csproj index bd007666ff..31b3f7668a 100644 --- a/src/Senparc.Weixin.WxOpen/src/Senparc.Weixin.WxOpen/Senparc.Weixin.WxOpen/Senparc.Weixin.WxOpen.net7.csproj +++ b/src/Senparc.Weixin.WxOpen/src/Senparc.Weixin.WxOpen/Senparc.Weixin.WxOpen/Senparc.Weixin.WxOpen.net7.csproj @@ -1,7 +1,7 @@ net462;netstandard2.0;netstandard2.1 - 3.16.3 + 3.16.4 9.0 Senparc.Weixin.WxOpen Senparc.Weixin.WxOpen @@ -174,7 +174,8 @@ v3.15.15 添加物流服务相关接口和事件推送 PR #2834 v3.15.15.1 获取小程序服务GenerateScheme模型增加env_version字段 PR #2861 v3.16.0 客服接口支持长文本自动切割后连续发送 - + v3.16.4 微信已于2023 年 9 月 20 日收回下发统一消息接口，标注过时 PR #2921 + https://github.com/JeffreySu/WeiXinMPSDK From b7abc1c48b2e85678eacc11cc1149a76c01c461f Mon Sep 17 00:00:00 2001 From: JeffreySu Date: Mon, 9 Oct 2023 01:12:41 +0800 Subject: [PATCH 4/5] =?UTF-8?q?WxOpen=20v3.16.4=20=E5=BE=AE=E4=BF=A1?= =?UTF-8?q?=E5=B7=B2=E4=BA=8E2023=20=E5=B9=B4=209=20=E6=9C=88=2020=20?= =?UTF-8?q?=E6=97=A5=E6=94=B6=E5=9B=9E=E4=B8=8B=E5=8F=91=E7=BB=9F=E4=B8=80?= =?UTF-8?q?=E6=B6=88=E6=81=AF=E6=8E=A5=E5=8F=A3=EF=BC=8C=E6=A0=87=E6=B3=A8?= =?UTF-8?q?=E8=BF=87=E6=97=B6=20#2921=20=E6=84=9F=E8=B0=A2=20@lishewen?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../Senparc.Weixin.WxOpen/AdvancedAPIs/Template/TemplateApi.cs | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/Senparc.Weixin.WxOpen/src/Senparc.Weixin.WxOpen/Senparc.Weixin.WxOpen/AdvancedAPIs/Template/TemplateApi.cs b/src/Senparc.Weixin.WxOpen/src/Senparc.Weixin.WxOpen/Senparc.Weixin.WxOpen/AdvancedAPIs/Template/TemplateApi.cs index dd9ab0e8b1..c69d23bf14 100644 --- a/src/Senparc.Weixin.WxOpen/src/Senparc.Weixin.WxOpen/Senparc.Weixin.WxOpen/AdvancedAPIs/Template/TemplateApi.cs +++ b/src/Senparc.Weixin.WxOpen/src/Senparc.Weixin.WxOpen/Senparc.Weixin.WxOpen/AdvancedAPIs/Template/TemplateApi.cs @@ -42,6 +42,9 @@ and limitations under the License. 修改标识：Senparc - 20181009 修改描述：添加下发小程序和公众号统一的服务消息接口 + 修改标识：Senparc - 20231009 + 修改描述：v3.16.4 微信已于2023 年 9 月 20 日收回下发统一消息接口，标注过时 + ----------------------------------------------------------------*/ /* From daea34ffb20c3a652142f6ac3601beaf9e192500 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=B7=B3=E5=86=89?= <455274752@qq.com> Date: Mon, 9 Oct 2023 21:59:50 +0800 Subject: [PATCH 5/5] =?UTF-8?q?=E6=96=87=E6=A1=A3=E6=A8=A1=E5=9D=97?= =?UTF-8?q?=E9=87=8D=E6=9E=84=EF=BC=8C=E8=A7=A3=E5=86=B3bug=E9=97=AE?= =?UTF-8?q?=E9=A2=98=EF=BC=8C=E6=B7=BB=E5=8A=A0=E5=AF=BC=E8=88=AA=E7=9B=AE?= =?UTF-8?q?=E5=BD=95=E7=AD=89?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/.vuepress/config.js | 194 +++++++++--------- docs/README-en.md | 68 +++++- docs/README.md | 75 ++++++- docs/dynamic-webapi/index.md | 1 - docs/en/README.md | 48 ++++- docs/en/guide/{lab.md => lib.md} | 0 ...ncedInterface.md => advanced-interface.md} | 0 docs/en/guide/mp/{MenuSetup.md => menu.md} | 0 .../guide/mp/{registration.md => register.md} | 0 .../mp/{source_code.md => source-code.md} | 0 .../{new_function.md => new-function.md} | 0 .../{Payment_callbacks.md => callback.md} | 0 .../tenpayv2/{JASPI_Payment.md => jssdk.md} | 0 .../{Native_Payment.md => nativepay.md} | 0 .../guide/tenpayv2/{Refunds.md => refund.md} | 0 .../tenpayv2/{Registration.md => register.md} | 0 .../{Source_code.md => source-code.md} | 0 .../{Payment_callbacks.md => callback.md} | 0 docs/en/guide/tenpayv3/{JASPI.md => jssdk.md} | 0 .../{Native_Payments.md => nativepay.md} | 0 .../guide/tenpayv3/{Refunds.md => refund.md} | 0 .../tenpayv3/{Registration.md => register.md} | 0 .../{Source_code.md => source-code.md} | 0 ...ced_Interface.md => advanced-interface.md} | 0 ...K_agentConfig.md => jssdk-agent-config.md} | 0 .../{JSSDK_General.md => jssdk-general.md} | 0 .../en/guide/work/{MenuSetting.md => menu.md} | 0 .../work/{Registration.md => register.md} | 0 .../work/{Source_code.md => source-code.md} | 0 ...ced_Interface.md => advanced-interface.md} | 0 ...t_Development.md => client-development.md} | 0 ...et_phone_number.md => get-phone-number.md} | 0 docs/en/guide/wxopen/{Sign_in.md => login.md} | 0 .../wxopen/{Registration.md => register.md} | 0 ..._Request_Service.md => request-service.md} | 0 .../wxopen/{Source_code.md => source-code.md} | 0 docs/zh/README.md | 48 ++++- .../zh/guide/MP/advanced-interface.md | 0 .../zh/guide/MP/advanced.md | 0 .../zh/guide/MP/install.md | 0 .../zh/guide/MP/menu.md | 0 .../zh/guide/MP/register.md | 0 .../zh/guide/MP/source-code.md | 0 .../zh/guide/Work/advanced-interface.md | 0 .../zh/guide/Work/advanced.md | 0 .../zh/guide/Work/install.md | 0 ...K_agentConfig.md => jssdk-agent-config.md} | 0 .../zh/guide/Work/jssdk-general.md | 0 .../zh/guide/Work/menu.md | 0 .../zh/guide/Work/register.md | 0 .../zh/guide/Work/source-code.md | 0 .../zh/guide/WxOpen/advanced-interface.md | 0 .../zh/guide/WxOpen/advanced.md | 0 .../zh/guide/WxOpen/client-development.md | 0 .../zh/guide/WxOpen/get-phone-number.md | 0 .../zh/guide/WxOpen/install.md | 0 .../zh/guide/WxOpen/login.md | 0 .../zh/guide/WxOpen/other.md | 0 .../zh/guide/WxOpen/register.md | 0 .../zh/guide/WxOpen/request-service.md | 0 .../zh/guide/WxOpen/source-code.md | 0 .../zh/guide/lib.md | 0 .../{new_function.md => new-function.md} | 0 .../zh/guide/tenpayv2/advanced.md | 0 .../zh/guide/tenpayv2/callback.md | 0 .../zh/guide/tenpayv2/install.md | 0 .../{TenPayV2/JASPI.md => tenpayv2/jssdk.md} | 0 .../zh/guide/tenpayv2/nativepay.md | 0 .../zh/guide/tenpayv2/refund.md | 0 .../zh/guide/tenpayv2/register.md | 0 .../zh/guide/tenpayv2/source-code.md | 0 .../zh/guide/tenpayv3/advanced.md | 0 .../zh/guide/tenpayv3/callback.md | 0 .../zh/guide/tenpayv3/install.md | 0 .../{TenPayV3/JASPI.md => tenpayv3/jssdk.md} | 0 .../zh/guide/tenpayv3/nativepay.md | 0 .../zh/guide/tenpayv3/refund.md | 0 .../zh/guide/tenpayv3/register.md | 0 .../zh/guide/tenpayv3/source-code.md | 0 docs/zh/release/log.md | 5 - docs/zh/release/new_function.md | 1 - readme.en.md | 25 +++ readme.md | 5 +- 83 files changed, 334 insertions(+), 136 deletions(-) delete mode 100644 docs/dynamic-webapi/index.md rename docs/en/guide/{lab.md => lib.md} (100%) rename docs/en/guide/mp/{AdvancedInterface.md => advanced-interface.md} (100%) rename docs/en/guide/mp/{MenuSetup.md => menu.md} (100%) rename docs/en/guide/mp/{registration.md => register.md} (100%) rename docs/en/guide/mp/{source_code.md => source-code.md} (100%) rename docs/en/guide/release/{new_function.md => new-function.md} (100%) rename docs/en/guide/tenpayv2/{Payment_callbacks.md => callback.md} (100%) rename docs/en/guide/tenpayv2/{JASPI_Payment.md => jssdk.md} (100%) rename docs/en/guide/tenpayv2/{Native_Payment.md => nativepay.md} (100%) rename docs/en/guide/tenpayv2/{Refunds.md => refund.md} (100%) rename docs/en/guide/tenpayv2/{Registration.md => register.md} (100%) rename docs/en/guide/tenpayv2/{Source_code.md => source-code.md} (100%) rename docs/en/guide/tenpayv3/{Payment_callbacks.md => callback.md} (100%) rename docs/en/guide/tenpayv3/{JASPI.md => jssdk.md} (100%) rename docs/en/guide/tenpayv3/{Native_Payments.md => nativepay.md} (100%) rename docs/en/guide/tenpayv3/{Refunds.md => refund.md} (100%) rename docs/en/guide/tenpayv3/{Registration.md => register.md} (100%) rename docs/en/guide/tenpayv3/{Source_code.md => source-code.md} (100%) rename docs/en/guide/work/{Advanced_Interface.md => advanced-interface.md} (100%) rename docs/en/guide/work/{JSSDK_agentConfig.md => jssdk-agent-config.md} (100%) rename docs/en/guide/work/{JSSDK_General.md => jssdk-general.md} (100%) rename docs/en/guide/work/{MenuSetting.md => menu.md} (100%) rename docs/en/guide/work/{Registration.md => register.md} (100%) rename docs/en/guide/work/{Source_code.md => source-code.md} (100%) rename docs/en/guide/wxopen/{Advanced_Interface.md => advanced-interface.md} (100%) rename docs/en/guide/wxopen/{Client_Development.md => client-development.md} (100%) rename docs/en/guide/wxopen/{Get_phone_number.md => get-phone-number.md} (100%) rename docs/en/guide/wxopen/{Sign_in.md => login.md} (100%) rename docs/en/guide/wxopen/{Registration.md => register.md} (100%) rename docs/en/guide/wxopen/{Applet_Request_Service.md => request-service.md} (100%) rename docs/en/guide/wxopen/{Source_code.md => source-code.md} (100%) rename "docs/zh/guide/MP/\351\253\230\347\272\247\346\216\245\345\217\243.md" => docs/zh/guide/MP/advanced-interface.md (100%) rename "docs/zh/guide/MP/\350\277\233\351\230\266.md" => docs/zh/guide/MP/advanced.md (100%) rename "docs/zh/guide/MP/\345\246\202\344\275\225\345\256\211\350\243\205.md" => docs/zh/guide/MP/install.md (100%) rename "docs/zh/guide/MP/\350\217\234\345\215\225\350\256\276\347\275\256.md" => docs/zh/guide/MP/menu.md (100%) rename "docs/zh/guide/MP/\346\263\250\345\206\214.md" => docs/zh/guide/MP/register.md (100%) rename "docs/zh/guide/MP/\346\272\220\347\240\201.md" => docs/zh/guide/MP/source-code.md (100%) rename "docs/zh/guide/Work/\351\253\230\347\272\247\346\216\245\345\217\243.md" => docs/zh/guide/Work/advanced-interface.md (100%) rename "docs/zh/guide/TenPayV2/\350\277\233\351\230\266.md" => docs/zh/guide/Work/advanced.md (100%) rename "docs/zh/guide/Work/\345\246\202\344\275\225\345\256\211\350\243\205.md" => docs/zh/guide/Work/install.md (100%) rename docs/zh/guide/Work/{JSSDK_agentConfig.md => jssdk-agent-config.md} (100%) rename "docs/zh/guide/Work/JSSDK\345\270\270\350\247\204.md" => docs/zh/guide/Work/jssdk-general.md (100%) rename "docs/zh/guide/Work/\350\217\234\345\215\225\350\256\276\347\275\256.md" => docs/zh/guide/Work/menu.md (100%) rename "docs/zh/guide/Work/\346\263\250\345\206\214.md" => docs/zh/guide/Work/register.md (100%) rename "docs/zh/guide/Work/\346\272\220\347\240\201.md" => docs/zh/guide/Work/source-code.md (100%) rename "docs/zh/guide/WxOpen/\351\253\230\347\272\247\346\216\245\345\217\243.md" => docs/zh/guide/WxOpen/advanced-interface.md (100%) rename "docs/zh/guide/TenPayV3/\350\277\233\351\230\266.md" => docs/zh/guide/WxOpen/advanced.md (100%) rename "docs/zh/guide/WxOpen/\345\256\242\346\210\267\347\253\257\345\274\200\345\217\221.md" => docs/zh/guide/WxOpen/client-development.md (100%) rename "docs/zh/guide/WxOpen/\350\216\267\345\217\226\346\211\213\346\234\272\345\217\267.md" => docs/zh/guide/WxOpen/get-phone-number.md (100%) rename "docs/zh/guide/WxOpen/\345\246\202\344\275\225\345\256\211\350\243\205.md" => docs/zh/guide/WxOpen/install.md (100%) rename "docs/zh/guide/WxOpen/\347\231\273\345\275\225.md" => docs/zh/guide/WxOpen/login.md (100%) rename "docs/zh/guide/WxOpen/\345\205\266\344\273\226.md" => docs/zh/guide/WxOpen/other.md (100%) rename "docs/zh/guide/WxOpen/\346\263\250\345\206\214.md" => docs/zh/guide/WxOpen/register.md (100%) rename "docs/zh/guide/WxOpen/\345\260\217\347\250\213\345\272\217\346\234\215\345\212\241\350\257\267\346\261\202.md" => docs/zh/guide/WxOpen/request-service.md (100%) rename "docs/zh/guide/WxOpen/\346\272\220\347\240\201.md" => docs/zh/guide/WxOpen/source-code.md (100%) rename "docs/zh/guide/\345\272\223\345\222\214\347\273\204\344\273\266.md" => docs/zh/guide/lib.md (100%) rename docs/zh/guide/release/{new_function.md => new-function.md} (100%) rename "docs/zh/guide/Work/\350\277\233\351\230\266.md" => docs/zh/guide/tenpayv2/advanced.md (100%) rename "docs/zh/guide/TenPayV2/\346\224\257\344\273\230\345\233\236\350\260\203.md" => docs/zh/guide/tenpayv2/callback.md (100%) rename "docs/zh/guide/TenPayV2/\345\246\202\344\275\225\345\256\211\350\243\205.md" => docs/zh/guide/tenpayv2/install.md (100%) rename docs/zh/guide/{TenPayV2/JASPI.md => tenpayv2/jssdk.md} (100%) rename "docs/zh/guide/TenPayV2/Native\346\224\257\344\273\230.md" => docs/zh/guide/tenpayv2/nativepay.md (100%) rename "docs/zh/guide/TenPayV2/\351\200\200\346\254\276.md" => docs/zh/guide/tenpayv2/refund.md (100%) rename "docs/zh/guide/TenPayV2/\346\263\250\345\206\214.md" => docs/zh/guide/tenpayv2/register.md (100%) rename "docs/zh/guide/TenPayV2/\346\272\220\347\240\201.md" => docs/zh/guide/tenpayv2/source-code.md (100%) rename "docs/zh/guide/WxOpen/\350\277\233\351\230\266.md" => docs/zh/guide/tenpayv3/advanced.md (100%) rename "docs/zh/guide/TenPayV3/\346\224\257\344\273\230\345\233\236\350\260\203.md" => docs/zh/guide/tenpayv3/callback.md (100%) rename "docs/zh/guide/TenPayV3/\345\246\202\344\275\225\345\256\211\350\243\205.md" => docs/zh/guide/tenpayv3/install.md (100%) rename docs/zh/guide/{TenPayV3/JASPI.md => tenpayv3/jssdk.md} (100%) rename "docs/zh/guide/TenPayV3/Native\346\224\257\344\273\230.md" => docs/zh/guide/tenpayv3/nativepay.md (100%) rename "docs/zh/guide/TenPayV3/\351\200\200\346\254\276.md" => docs/zh/guide/tenpayv3/refund.md (100%) rename "docs/zh/guide/TenPayV3/\346\263\250\345\206\214.md" => docs/zh/guide/tenpayv3/register.md (100%) rename "docs/zh/guide/TenPayV3/\346\272\220\347\240\201.md" => docs/zh/guide/tenpayv3/source-code.md (100%) delete mode 100644 docs/zh/release/log.md delete mode 100644 docs/zh/release/new_function.md diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 62157536b8..94f9ca726a 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -1,6 +1,8 @@ module.exports = { - base: "/docs/zh/", + base: "/docs/", lang: "zh-CN", + title: '微信 .NET SDK文档', + description: "使用 Senparc.Weixin，您可以方便快速地开发微信全平台的应用（包括微信公众号、小程序、小游戏、企业号、开放平台、微信支付、JS-SDK、微信硬件/蓝牙，等等）。本项目的 Demo 同样适合初学者进行 .NET 编程学习。", head: [ ["link", { rel: "shortcut icon", type: "image/x-icon", href: "/icon.jpg" }], ["script", {}, ``], @@ -9,14 +11,12 @@ module.exports = { "/en/": { lang: "en-US", title: "Wechat.NET SDK", - description: - "With Senparc.Weixin, you can easily and quickly develop applications for all platforms of wechat (including wechat public number, mini program, mini game, enterprise number, open platform, wechat Pay, JS-SDK, wechat hardware/Bluetooth, etc.). The Demo of this project is also suitable for beginners to learn.NET programming.", + description: "With Senparc.Weixin, you can easily and quickly develop applications for all platforms of wechat (including wechat public number, mini program, mini game, enterprise number, open platform, wechat Pay, JS-SDK, wechat hardware/Bluetooth, etc.). The Demo of this project is also suitable for beginners to learn.NET programming.", }, "/zh/": { lang: "zh-CN", title: "微信 .NET SDK文档", - description: - "使用 Senparc.Weixin，您可以方便快速地开发微信全平台的应用（包括微信公众号、小程序、小游戏、企业号、开放平台、微信支付、JS-SDK、微信硬件/蓝牙，等等）。本项目的 Demo 同样适合初学者进行 .NET 编程学习。", + description: "使用 Senparc.Weixin，您可以方便快速地开发微信全平台的应用（包括微信公众号、小程序、小游戏、企业号、开放平台、微信支付、JS-SDK、微信硬件/蓝牙，等等）。本项目的 Demo 同样适合初学者进行 .NET 编程学习。", }, }, // evergreen: true, @@ -85,89 +85,89 @@ module.exports = { { title: "Guide", collapsable: false, - children: ["", "lab"], + children: ["", "lib"], }, { title: "MP", collapsable: false, children: [ - "mp/source_code", + "mp/source-code", "mp/install", - "mp/registration", - "mp/MessageHandler", - "mp/AdvancedInterface", - "mp/JSSDK", - "mp/OAuth2.0", - "mp/MenuSetup", - "mp/Advanced", + "mp/register", + "mp/messagehandler", + "mp/advanced-interface", + "mp/jssdk", + "mp/oauth2.0", + "mp/menu", + "mp/advanced", ], }, { - title: "WXOpen", + title: "WxOpen", collapsable: false, children: [ - "wxopen/Source_code", + "wxopen/source-code", "wxopen/install", - "wxopen/Registration", - "wxopen/MessageHandler", - "wxopen/Advanced_Interface", - "wxopen/Client_Development", - "wxopen/Applet_Request_Service", - "wxopen/Sign_in", - "wxopen/Get_phone_number", - "wxopen/Other", - "wxopen/Advanced", + "wxopen/register", + "wxopen/messagehandler", + "wxopen/advanced-interface", + "wxopen/client-development", + "wxopen/request-service", + "wxopen/login", + "wxopen/get-phone-number", + "wxopen/other", + "wxopen/advanced", ], }, { title: "Work", collapsable: false, children: [ - "work/Source_code", + "work/source-code", "work/install", - "work/Registration", - "work/MessageHandler", - "work/Advanced_Interface", - "work/JSSDK_General", - "work/JSSDK_agentConfig", - "work/OAuth2.0", - "work/MenuSetting", - "work/Advanced", + "work/register", + "work/messagehandler", + "work/advanced-interface", + "work/jssdk-general", + "work/jssdk-agent-config", + "work/oauth2.0", + "work/menu", + "work/advanced", ], }, { title: "TenpayV3", collapsable: false, children: [ - "tenpayv3/Source_code", + "tenpayv3/source-code", "tenpayv3/install", - "tenpayv3/Registration", - "tenpayv3/JASPI", - "tenpayv3/Payment_callbacks", - "tenpayv3/Native_Payments", - "tenpayv3/Refunds", - "tenpayv3/Advanced", + "tenpayv3/register", + "tenpayv3/jssdk", + "tenpayv3/callback", + "tenpayv3/nativepay", + "tenpayv3/refund", + "tenpayv3/advanced", ], }, { title: "TenpayV2", collapsable: false, children: [ - "tenpayv2/Source_code", + "tenpayv2/source-code", "tenpayv2/install", - "tenpayv2/Registration", - "tenpayv2/JASPI_Payment", - "tenpayv2/Payment_callbacks", - "tenpayv2/Native_Payment", - "tenpayv2/Refunds", - "tenpayv2/Advanced", + "tenpayv2/register", + "tenpayv2/jssdk", + "tenpayv2/callback", + "tenpayv2/nativepay", + "tenpayv2/refund", + "tenpayv2/advanced", ], }, { title: "Newly Release", collapsable: false, children: [ - "/en/guide/release/new_function", + "/en/guide/release/new-function", "/en/guide/release/log", ], }, @@ -219,89 +219,89 @@ module.exports = { { title: "概要", collapsable: false, - children: ["", "库和组件"], + children: ["", "lib"], }, { title: "公众号", collapsable: false, children: [ - "MP/源码", - "MP/如何安装", - "MP/注册", - "MP/MessageHandler", - "MP/高级接口", - "MP/JSSDK", - "MP/OAuth2.0", - "MP/菜单设置", - "MP/进阶", + "mp/source-code", + "mp/install", + "mp/register", + "mp/messagehandler", + "mp/advanced-interface", + "mp/jssdk", + "mp/oauth2.0", + "mp/menu", + "mp/advanced", ], }, { title: "小程序", collapsable: false, children: [ - "WxOpen/源码", - "WxOpen/如何安装", - "WxOpen/注册", - "WxOpen/MessageHandler", - "WxOpen/高级接口", - "WxOpen/客户端开发", - "WxOpen/小程序服务请求", - "WxOpen/登录", - "WxOpen/获取手机号", - "WxOpen/其他", - "WxOpen/进阶", + "wxopen/source-code", + "wxopen/install", + "wxopen/register", + "wxopen/messagehandler", + "wxopen/advanced-interface", + "wxopen/client-development", + "wxopen/request-service", + "wxopen/login", + "wxopen/get-phone-number", + "wxopen/other", + "wxopen/advanced", ], }, { title: "企业微信", collapsable: false, children: [ - "Work/源码", - "Work/如何安装", - "Work/注册", - "Work/MessageHandler", - "Work/高级接口", - "Work/JSSDK常规", - "Work/JSSDK_agentConfig", - "Work/OAuth2.0", - "Work/菜单设置", - "Work/进阶", + "work/source-code", + "work/install", + "work/register", + "work/messagehandler", + "work/advanced-interface", + "work/jssdk-general", + "work/jssdk-agent-config", + "work/oauth2.0", + "work/menu", + "work/advanced", ], }, { title: "微信支付V3", collapsable: false, children: [ - "TenPayV3/源码", - "TenPayV3/如何安装", - "TenPayV3/注册", - "TenPayV3/JASPI", - "TenPayV3/支付回调", - "TenPayV3/Native支付", - "TenPayV3/退款", - "TenPayV3/进阶", + "tenpayv3/source-code", + "tenpayv3/install", + "tenpayv3/register", + "tenpayv3/jssdk", + "tenpayv3/callback", + "tenpayv3/nativepay", + "tenpayv3/refund", + "tenpayv3/advanced", ], }, { title: "微信支付V2", collapsable: false, children: [ - "TenPayV2/源码", - "TenPayV2/如何安装", - "TenPayV2/注册", - "TenPayV2/JASPI", - "TenPayV2/支付回调", - "TenPayV2/Native支付", - "TenPayV2/退款", - "TenPayV2/进阶", + "tenpayv2/source-code", + "tenpayv2/install", + "tenpayv2/register", + "tenpayv2/jssdk", + "tenpayv2/callback", + "tenpayv2/nativepay", + "tenpayv2/refund", + "tenpayv2/advanced", ], }, { title: "新发布", collapsable: false, children: [ - "/zh/guide/release/new_function", + "/zh/guide/release/new-function", "/zh/guide/release/log", ], }, diff --git a/docs/README-en.md b/docs/README-en.md index a005ef126b..90c7c8e706 100644 --- a/docs/README-en.md +++ b/docs/README-en.md @@ -14,13 +14,67 @@ features: details: Senparc.Weixin SDK Extension components are used to provide a series of extension modules such as cache and WebSocket. --- -| Document catalogue | Description | -| ------------------------------------ | ---------------------- | -| [en/guide/MP](guide/MP/) | MP Documentation | -| [en/guide/TenPayV2](guide/TenPayV2/) | TenPayV2 Documentation | -| [en/guide/TenPayV3](guide/TenPayV3/) | TenPayV3 Documentation | -| [en/guide/Work](guide/Work/) | Work Documentation | -| [en/guide/WxOpen](guide/WxOpen/) | WxOpen Documentation | +**Readings：** The Node version can be managed using NVM, Download[NVM](https://github.com/coreybutler/nvm-windows/releases)。 + +1. Install yarn using Node + + ``` bash + npm install -g yarn + ``` + +2. Installation project dependent run (project source root run) + + ``` bash + yarn install + ``` + +3. Run document project + + ``` bash + yarn docs:dev + ``` + + + +## Document catalogue + +| Document catalogue | Description | +| ------------------------------------------------------------------------------- | ---------------------------------- | +| [zh/guide/](zh/guide/) | **Guide** | +| [zh/guide/mp/](zh/guide/mp/install.html) | **MP Document** | +| [ zh/guide/mp/jssdk/](zh/guide/mp/jssdk.html) |  JSSDK | +| [ zh/guide/mp/oauth2.0/](zh/guide/mp/oauth2.0.html) |  OAuth 2.0 | +| [ zh/guide/mp/menu/](zh/guide/mp/menu.html) |  Menu Setting | +| [zh/guide/wxopen/](zh/guide/wxopen/install.html) | **WxOpen Document** | +| [ zh/guide/request-service/](zh/guide/wxopen/request-service.html) |  MiniProgram Request Service | +| [ zh/guide/login/](zh/guide/wxopen/login.html) |  Login | +| [ zh/guide/get-phone-number/](zh/guide/wxopen/get-phone-number.html) |  GetPhoneNumber | +| [zh/guide/work/](zh/guide/work/install.html) | **Work Document** | +| [ zh/guide/work/jssdk-general/](zh/guide/work/jssdk-general.html) |  JSSDK (General) | +| [ zh/guide/work/jssdk-agent-config/](zh/guide/work/jssdk-agent-config.html)|  JSSDK(agentConfig) | +| [ zh/guide/work/oauth2.0/](zh/guide/work/oauth2.0.html) |  OAuth 2.0 | +| [ zh/guide/work/menu/](zh/guide/work/menu.html) |  Menu Setting | +| [zh/guide/tenpayv3/](zh/guide/tenpayv3/install.html) | **TenPayV3 Document** | +| [ zh/guide/tenpayv3/jssdk/](zh/guide/tenpayv3/jssdk.html) |  JSAPI | +| [ zh/guide/tenpayv3/callback/](zh/guide/tenpayv3/callback.html) |  PayNotify | +| [ zh/guide/tenpayv3/nativepay/](zh/guide/tenpayv3/nativepay.html) |  Native Pay | +| [ zh/guide/tenpayv3/refund/](zh/guide/tenpayv3/refund.html) |  Refund | +| [zh/guide/tenpayv2/](zh/guide/tenpayv2/install.html) | **TenPayV2 Document** | +| [ zh/guide/tenpayv2/jssdk/](zh/guide/tenpayv2/jssdk.html) |  JSAPI | +| [ zh/guide/tenpayv2/callback/](zh/guide/tenpayv2/callback.html) |  PayNotify | +| [ zh/guide/tenpayv2/nativepay/](zh/guide/tenpayv2/nativepay.html) |  Native Pay | +| [ zh/guide/tenpayv2/refund/](zh/guide/tenpayv2/refund.html) |  Refund | ::: slot footer Apache License Version 2.0 | Copyright © 2006-present [JeffreySu/WeiXinMPSDK](https://github.com/JeffreySu/WeiXinMPSDK) diff --git a/docs/README.md b/docs/README.md index 2583afa6a6..00bea8a973 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,5 +1,6 @@ --- home: true +navbar: false heroImage: /icon.jpg heroText: JeffreySu/WeiXinMPSDK tagline: 轻松打造微信各平台的扩展应用 @@ -14,13 +15,73 @@ features: details: Senparc.Weixin SDK 扩展组件用于提供缓存、WebSocket 等一系列扩展模块。 --- -| 中文文档目录 | 说明 | -| -------------------------------------------- | ---------------- | -| [docs/zh/guide/MP](zh/guide/MP/) | 公众号模块文档 | -| [docs/zh/guide/TenPayV2](zh/guide/TenPayV2/) | 微信支付 V2 文档 | -| [docs/zh/guide/TenPayV3](zh/guide/TenPayV3/) | 微信支付 V3 文档 | -| [docs/zh/guide/Work](zh/guide/Work/) | 企业微信文档 | -| [docs/zh/guide/WxOpen](zh/guide/WxOpen/) | 小程序文档 | +## 如何使用文档 + +::: warning 前提条件 +文档需要 [Node.js](https://nodejs.org/en/) >= 8.6 +::: + +**相关阅读：** 可使用NVM管理Node版本，下载[NVM](https://github.com/coreybutler/nvm-windows/releases)。 + +1. 通过Node安装yarn + + ``` bash + npm install -g yarn + ``` + +2. 安装项目依赖运行(项目源码根目录运行) + + ``` bash + yarn install + ``` + +3. 运行文档项目 + + ``` bash + yarn docs:dev + ``` + + + +## 文档目录 + +| 中文文档目录 | 说明 | +| ------------------------------------------------------------------------------- | ------------------------ | +| [zh/guide/](zh/guide/) | **概要** | +| [zh/guide/mp/](zh/guide/mp/install.html) | **公众号模块文档** | +| [ zh/guide/mp/jssdk/](zh/guide/mp/jssdk.html) |  JSSDK | +| [ zh/guide/mp/oauth2.0/](zh/guide/mp/oauth2.0.html) |  OAuth 2.0 | +| [ zh/guide/mp/menu/](zh/guide/mp/menu.html) |  菜单设置 | +| [zh/guide/wxopen/](zh/guide/wxopen/install.html) | **小程序文档** | +| [ zh/guide/request-service/](zh/guide/wxopen/request-service.html) |  小程序请求服务 | +| [ zh/guide/login/](zh/guide/wxopen/login.html) |  登录 | +| [ zh/guide/get-phone-number/](zh/guide/wxopen/get-phone-number.html) |  获取手机号 | +| [zh/guide/work/](zh/guide/work/install.html) | **企业微信文档** | +| [ zh/guide/work/jssdk-general/](zh/guide/work/jssdk-general.html) |  JSSDK常规 | +| [ zh/guide/work/jssdk-agent-config/](zh/guide/work/jssdk-agent-config.html)|  JSSDK(agentConfig) | +| [ zh/guide/work/oauth2.0/](zh/guide/work/oauth2.0.html) |  OAuth 2.0 | +| [ zh/guide/work/menu/](zh/guide/work/menu.html) |  菜单设置 | +| [zh/guide/tenpayv3/](zh/guide/tenpayv3/install.html) | **微信支付 V3 文档** | +| [ zh/guide/tenpayv3/jssdk/](zh/guide/tenpayv3/jssdk.html) |  JSAPI 支付 | +| [ zh/guide/tenpayv3/callback/](zh/guide/tenpayv3/callback.html) |  支付回调 | +| [ zh/guide/tenpayv3/nativepay/](zh/guide/tenpayv3/nativepay.html) |  Native 支付 | +| [ zh/guide/tenpayv3/refund/](zh/guide/tenpayv3/refund.html) |  退款 | +| [zh/guide/tenpayv2/](zh/guide/tenpayv2/install.html) | **微信支付 V2 文档** | +| [ zh/guide/tenpayv2/jssdk/](zh/guide/tenpayv2/jssdk.html) |  JSAPI 支付 | +| [ zh/guide/tenpayv2/callback/](zh/guide/tenpayv2/callback.html) |  支付回调 | +| [ zh/guide/tenpayv2/nativepay/](zh/guide/tenpayv2/nativepay.html) |  Native 支付 | +| [ zh/guide/tenpayv2/refund/](zh/guide/tenpayv2/refund.html) |  退款 | ::: slot footer Apache License Version 2.0 | Copyright © 2006-present [JeffreySu/WeiXinMPSDK](https://github.com/JeffreySu/WeiXinMPSDK) diff --git a/docs/dynamic-webapi/index.md b/docs/dynamic-webapi/index.md deleted file mode 100644 index 830b2c9156..0000000000 --- a/docs/dynamic-webapi/index.md +++ /dev/null @@ -1 +0,0 @@ -# Dynamic WebApi diff --git a/docs/en/README.md b/docs/en/README.md index b5a2a2f6c8..cdad32dccc 100644 --- a/docs/en/README.md +++ b/docs/en/README.md @@ -14,13 +14,47 @@ features: details: Senparc.Weixin SDK Extension components are used to provide a series of extension modules such as cache and WebSocket. --- -| Document catalogue | Description | -| --------------------------------- | ---------------------- | -| [guide/MP](guide/MP/) | MP Documentation | -| [guide/TenPayV2](guide/TenPayV2/) | TenPayV2 Documentation | -| [guide/TenPayV3](guide/TenPayV3/) | TenPayV3 Documentation | -| [guide/Work](guide/Work/) | Work Documentation | -| [guide/WxOpen](guide/WxOpen/) | WxOpen Documentation | + + +## Document catalogue + +| Document catalogue | Description | +| ------------------------------------------------------------------------------- | ---------------------------------- | +| [guide/](guide/) | **Guide** | +| [guide/mp/](guide/mp/install.html) | **MP Document** | +| [ guide/mp/jssdk/](guide/mp/jssdk.html) |  JSSDK | +| [ guide/mp/oauth2.0/](guide/mp/oauth2.0.html) |  OAuth 2.0 | +| [ guide/mp/menu/](guide/mp/menu.html) |  Menu Setting | +| [guide/wxopen/](guide/wxopen/install.html) | **WxOpen Document** | +| [ guide/request-service/](guide/wxopen/request-service.html) |  MiniProgram Request Service | +| [ guide/login/](guide/wxopen/login.html) |  Login | +| [ guide/get-phone-number/](guide/wxopen/get-phone-number.html) |  GetPhoneNumber | +| [guide/work/](guide/work/install.html) | **Work Document** | +| [ guide/work/jssdk-general/](guide/work/jssdk-general.html) |  JSSDK (General) | +| [ guide/work/jssdk-agent-config/](guide/work/jssdk-agent-config.html)|  JSSDK(agentConfig) | +| [ guide/work/oauth2.0/](guide/work/oauth2.0.html) |  OAuth 2.0 | +| [ guide/work/menu/](guide/work/menu.html) |  Menu Setting | +| [guide/tenpayv3/](guide/tenpayv3/install.html) | **TenPayV3 Document** | +| [ guide/tenpayv3/jssdk/](guide/tenpayv3/jssdk.html) |  JSAPI | +| [ guide/tenpayv3/callback/](guide/tenpayv3/callback.html) |  PayNotify | +| [ guide/tenpayv3/nativepay/](guide/tenpayv3/nativepay.html) |  Native Pay | +| [ guide/tenpayv3/refund/](guide/tenpayv3/refund.html) |  Refund | +| [guide/tenpayv2/](guide/tenpayv2/install.html) | **TenPayV2 Document** | +| [ guide/tenpayv2/jssdk/](guide/tenpayv2/jssdk.html) |  JSAPI | +| [ guide/tenpayv2/callback/](guide/tenpayv2/callback.html) |  PayNotify | +| [ guide/tenpayv2/nativepay/](guide/tenpayv2/nativepay.html) |  Native Pay | +| [ guide/tenpayv2/refund/](guide/tenpayv2/refund.html) |  Refund | ::: slot footer Apache License Version 2.0 | Copyright © 2006-present [JeffreySu/WeiXinMPSDK](https://github.com/JeffreySu/WeiXinMPSDK) diff --git a/docs/en/guide/lab.md b/docs/en/guide/lib.md similarity index 100% rename from docs/en/guide/lab.md rename to docs/en/guide/lib.md diff --git a/docs/en/guide/mp/AdvancedInterface.md b/docs/en/guide/mp/advanced-interface.md similarity index 100% rename from docs/en/guide/mp/AdvancedInterface.md rename to docs/en/guide/mp/advanced-interface.md diff --git a/docs/en/guide/mp/MenuSetup.md b/docs/en/guide/mp/menu.md similarity index 100% rename from docs/en/guide/mp/MenuSetup.md rename to docs/en/guide/mp/menu.md diff --git a/docs/en/guide/mp/registration.md b/docs/en/guide/mp/register.md similarity index 100% rename from docs/en/guide/mp/registration.md rename to docs/en/guide/mp/register.md diff --git a/docs/en/guide/mp/source_code.md b/docs/en/guide/mp/source-code.md similarity index 100% rename from docs/en/guide/mp/source_code.md rename to docs/en/guide/mp/source-code.md diff --git a/docs/en/guide/release/new_function.md b/docs/en/guide/release/new-function.md similarity index 100% rename from docs/en/guide/release/new_function.md rename to docs/en/guide/release/new-function.md diff --git a/docs/en/guide/tenpayv2/Payment_callbacks.md b/docs/en/guide/tenpayv2/callback.md similarity index 100% rename from docs/en/guide/tenpayv2/Payment_callbacks.md rename to docs/en/guide/tenpayv2/callback.md diff --git a/docs/en/guide/tenpayv2/JASPI_Payment.md b/docs/en/guide/tenpayv2/jssdk.md similarity index 100% rename from docs/en/guide/tenpayv2/JASPI_Payment.md rename to docs/en/guide/tenpayv2/jssdk.md diff --git a/docs/en/guide/tenpayv2/Native_Payment.md b/docs/en/guide/tenpayv2/nativepay.md similarity index 100% rename from docs/en/guide/tenpayv2/Native_Payment.md rename to docs/en/guide/tenpayv2/nativepay.md diff --git a/docs/en/guide/tenpayv2/Refunds.md b/docs/en/guide/tenpayv2/refund.md similarity index 100% rename from docs/en/guide/tenpayv2/Refunds.md rename to docs/en/guide/tenpayv2/refund.md diff --git a/docs/en/guide/tenpayv2/Registration.md b/docs/en/guide/tenpayv2/register.md similarity index 100% rename from docs/en/guide/tenpayv2/Registration.md rename to docs/en/guide/tenpayv2/register.md diff --git a/docs/en/guide/tenpayv2/Source_code.md b/docs/en/guide/tenpayv2/source-code.md similarity index 100% rename from docs/en/guide/tenpayv2/Source_code.md rename to docs/en/guide/tenpayv2/source-code.md diff --git a/docs/en/guide/tenpayv3/Payment_callbacks.md b/docs/en/guide/tenpayv3/callback.md similarity index 100% rename from docs/en/guide/tenpayv3/Payment_callbacks.md rename to docs/en/guide/tenpayv3/callback.md diff --git a/docs/en/guide/tenpayv3/JASPI.md b/docs/en/guide/tenpayv3/jssdk.md similarity index 100% rename from docs/en/guide/tenpayv3/JASPI.md rename to docs/en/guide/tenpayv3/jssdk.md diff --git a/docs/en/guide/tenpayv3/Native_Payments.md b/docs/en/guide/tenpayv3/nativepay.md similarity index 100% rename from docs/en/guide/tenpayv3/Native_Payments.md rename to docs/en/guide/tenpayv3/nativepay.md diff --git a/docs/en/guide/tenpayv3/Refunds.md b/docs/en/guide/tenpayv3/refund.md similarity index 100% rename from docs/en/guide/tenpayv3/Refunds.md rename to docs/en/guide/tenpayv3/refund.md diff --git a/docs/en/guide/tenpayv3/Registration.md b/docs/en/guide/tenpayv3/register.md similarity index 100% rename from docs/en/guide/tenpayv3/Registration.md rename to docs/en/guide/tenpayv3/register.md diff --git a/docs/en/guide/tenpayv3/Source_code.md b/docs/en/guide/tenpayv3/source-code.md similarity index 100% rename from docs/en/guide/tenpayv3/Source_code.md rename to docs/en/guide/tenpayv3/source-code.md diff --git a/docs/en/guide/work/Advanced_Interface.md b/docs/en/guide/work/advanced-interface.md similarity index 100% rename from docs/en/guide/work/Advanced_Interface.md rename to docs/en/guide/work/advanced-interface.md diff --git a/docs/en/guide/work/JSSDK_agentConfig.md b/docs/en/guide/work/jssdk-agent-config.md similarity index 100% rename from docs/en/guide/work/JSSDK_agentConfig.md rename to docs/en/guide/work/jssdk-agent-config.md diff --git a/docs/en/guide/work/JSSDK_General.md b/docs/en/guide/work/jssdk-general.md similarity index 100% rename from docs/en/guide/work/JSSDK_General.md rename to docs/en/guide/work/jssdk-general.md diff --git a/docs/en/guide/work/MenuSetting.md b/docs/en/guide/work/menu.md similarity index 100% rename from docs/en/guide/work/MenuSetting.md rename to docs/en/guide/work/menu.md diff --git a/docs/en/guide/work/Registration.md b/docs/en/guide/work/register.md similarity index 100% rename from docs/en/guide/work/Registration.md rename to docs/en/guide/work/register.md diff --git a/docs/en/guide/work/Source_code.md b/docs/en/guide/work/source-code.md similarity index 100% rename from docs/en/guide/work/Source_code.md rename to docs/en/guide/work/source-code.md diff --git a/docs/en/guide/wxopen/Advanced_Interface.md b/docs/en/guide/wxopen/advanced-interface.md similarity index 100% rename from docs/en/guide/wxopen/Advanced_Interface.md rename to docs/en/guide/wxopen/advanced-interface.md diff --git a/docs/en/guide/wxopen/Client_Development.md b/docs/en/guide/wxopen/client-development.md similarity index 100% rename from docs/en/guide/wxopen/Client_Development.md rename to docs/en/guide/wxopen/client-development.md diff --git a/docs/en/guide/wxopen/Get_phone_number.md b/docs/en/guide/wxopen/get-phone-number.md similarity index 100% rename from docs/en/guide/wxopen/Get_phone_number.md rename to docs/en/guide/wxopen/get-phone-number.md diff --git a/docs/en/guide/wxopen/Sign_in.md b/docs/en/guide/wxopen/login.md similarity index 100% rename from docs/en/guide/wxopen/Sign_in.md rename to docs/en/guide/wxopen/login.md diff --git a/docs/en/guide/wxopen/Registration.md b/docs/en/guide/wxopen/register.md similarity index 100% rename from docs/en/guide/wxopen/Registration.md rename to docs/en/guide/wxopen/register.md diff --git a/docs/en/guide/wxopen/Applet_Request_Service.md b/docs/en/guide/wxopen/request-service.md similarity index 100% rename from docs/en/guide/wxopen/Applet_Request_Service.md rename to docs/en/guide/wxopen/request-service.md diff --git a/docs/en/guide/wxopen/Source_code.md b/docs/en/guide/wxopen/source-code.md similarity index 100% rename from docs/en/guide/wxopen/Source_code.md rename to docs/en/guide/wxopen/source-code.md diff --git a/docs/zh/README.md b/docs/zh/README.md index 0546cea3c1..1f7b305bfe 100644 --- a/docs/zh/README.md +++ b/docs/zh/README.md @@ -14,13 +14,47 @@ features: details: Senparc.Weixin SDK 扩展组件用于提供缓存、WebSocket 等一系列扩展模块。 --- -| 中文文档目录 | 说明 | -| --------------------------------- | ---------------- | -| [guide/MP](guide/MP/) | 公众号模块文档 | -| [guide/TenPayV2](guide/TenPayV2/) | 微信支付 V2 文档 | -| [guide/TenPayV3](guide/TenPayV3/) | 微信支付 V3 文档 | -| [guide/Work](guide/Work/) | 企业微信文档 | -| [guide/WxOpen](guide/WxOpen/) | 小程序文档 | + + +## 文档目录 + +| 中文文档目录 | 说明 | +| ------------------------------------------------------------------------------- | ------------------------ | +| [guide/](guide/) | **概要** | +| [guide/mp/](guide/mp/install.html) | **公众号模块文档** | +| [ guide/mp/jssdk/](guide/mp/jssdk.html) |  JSSDK | +| [ guide/mp/oauth2.0/](guide/mp/oauth2.0.html) |  OAuth 2.0 | +| [ guide/mp/menu/](guide/mp/menu.html) |  菜单设置 | +| [guide/wxopen/](guide/wxopen/install.html) | **小程序文档** | +| [ guide/request-service/](guide/wxopen/request-service.html) |  小程序请求服务 | +| [ guide/login/](guide/wxopen/login.html) |  登录 | +| [ guide/get-phone-number/](guide/wxopen/get-phone-number.html) |  获取手机号 | +| [guide/work/](guide/work/install.html) | **企业微信文档** | +| [ guide/work/jssdk-general/](guide/work/jssdk-general.html) |  JSSDK常规 | +| [ guide/work/jssdk-agent-config/](guide/work/jssdk-agent-config.html)|  JSSDK(agentConfig) | +| [ guide/work/oauth2.0/](guide/work/oauth2.0.html) |  OAuth 2.0 | +| [ guide/work/menu/](guide/work/menu.html) |  菜单设置 | +| [guide/tenpayv3/](guide/tenpayv3/install.html) | **微信支付 V3 文档** | +| [ guide/tenpayv3/jssdk/](guide/tenpayv3/jssdk.html) |  JSAPI 支付 | +| [ guide/tenpayv3/callback/](guide/tenpayv3/callback.html) |  支付回调 | +| [ guide/tenpayv3/nativepay/](guide/tenpayv3/nativepay.html) |  Native 支付 | +| [ guide/tenpayv3/refund/](guide/tenpayv3/refund.html) |  退款 | +| [guide/tenpayv2/](guide/tenpayv2/install.html) | **微信支付 V2 文档** | +| [ guide/tenpayv2/jssdk/](guide/tenpayv2/jssdk.html) |  JSAPI 支付 | +| [ guide/tenpayv2/callback/](guide/tenpayv2/callback.html) |  支付回调 | +| [ guide/tenpayv2/nativepay/](guide/tenpayv2/nativepay.html) |  Native 支付 | +| [ guide/tenpayv2/refund/](guide/tenpayv2/refund.html) |  退款 | ::: slot footer Apache License Version 2.0 | Copyright © 2006-present [JeffreySu/WeiXinMPSDK](https://github.com/JeffreySu/WeiXinMPSDK) diff --git "a/docs/zh/guide/MP/\351\253\230\347\272\247\346\216\245\345\217\243.md" b/docs/zh/guide/MP/advanced-interface.md similarity index 100% rename from "docs/zh/guide/MP/\351\253\230\347\272\247\346\216\245\345\217\243.md" rename to docs/zh/guide/MP/advanced-interface.md diff --git "a/docs/zh/guide/MP/\350\277\233\351\230\266.md" b/docs/zh/guide/MP/advanced.md similarity index 100% rename from "docs/zh/guide/MP/\350\277\233\351\230\266.md" rename to docs/zh/guide/MP/advanced.md diff --git "a/docs/zh/guide/MP/\345\246\202\344\275\225\345\256\211\350\243\205.md" b/docs/zh/guide/MP/install.md similarity index 100% rename from "docs/zh/guide/MP/\345\246\202\344\275\225\345\256\211\350\243\205.md" rename to docs/zh/guide/MP/install.md diff --git "a/docs/zh/guide/MP/\350\217\234\345\215\225\350\256\276\347\275\256.md" b/docs/zh/guide/MP/menu.md similarity index 100% rename from "docs/zh/guide/MP/\350\217\234\345\215\225\350\256\276\347\275\256.md" rename to docs/zh/guide/MP/menu.md diff --git "a/docs/zh/guide/MP/\346\263\250\345\206\214.md" b/docs/zh/guide/MP/register.md similarity index 100% rename from "docs/zh/guide/MP/\346\263\250\345\206\214.md" rename to docs/zh/guide/MP/register.md diff --git "a/docs/zh/guide/MP/\346\272\220\347\240\201.md" b/docs/zh/guide/MP/source-code.md similarity index 100% rename from "docs/zh/guide/MP/\346\272\220\347\240\201.md" rename to docs/zh/guide/MP/source-code.md diff --git "a/docs/zh/guide/Work/\351\253\230\347\272\247\346\216\245\345\217\243.md" b/docs/zh/guide/Work/advanced-interface.md similarity index 100% rename from "docs/zh/guide/Work/\351\253\230\347\272\247\346\216\245\345\217\243.md" rename to docs/zh/guide/Work/advanced-interface.md diff --git "a/docs/zh/guide/TenPayV2/\350\277\233\351\230\266.md" b/docs/zh/guide/Work/advanced.md similarity index 100% rename from "docs/zh/guide/TenPayV2/\350\277\233\351\230\266.md" rename to docs/zh/guide/Work/advanced.md diff --git "a/docs/zh/guide/Work/\345\246\202\344\275\225\345\256\211\350\243\205.md" b/docs/zh/guide/Work/install.md similarity index 100% rename from "docs/zh/guide/Work/\345\246\202\344\275\225\345\256\211\350\243\205.md" rename to docs/zh/guide/Work/install.md diff --git a/docs/zh/guide/Work/JSSDK_agentConfig.md b/docs/zh/guide/Work/jssdk-agent-config.md similarity index 100% rename from docs/zh/guide/Work/JSSDK_agentConfig.md rename to docs/zh/guide/Work/jssdk-agent-config.md diff --git "a/docs/zh/guide/Work/JSSDK\345\270\270\350\247\204.md" b/docs/zh/guide/Work/jssdk-general.md similarity index 100% rename from "docs/zh/guide/Work/JSSDK\345\270\270\350\247\204.md" rename to docs/zh/guide/Work/jssdk-general.md diff --git "a/docs/zh/guide/Work/\350\217\234\345\215\225\350\256\276\347\275\256.md" b/docs/zh/guide/Work/menu.md similarity index 100% rename from "docs/zh/guide/Work/\350\217\234\345\215\225\350\256\276\347\275\256.md" rename to docs/zh/guide/Work/menu.md diff --git "a/docs/zh/guide/Work/\346\263\250\345\206\214.md" b/docs/zh/guide/Work/register.md similarity index 100% rename from "docs/zh/guide/Work/\346\263\250\345\206\214.md" rename to docs/zh/guide/Work/register.md diff --git "a/docs/zh/guide/Work/\346\272\220\347\240\201.md" b/docs/zh/guide/Work/source-code.md similarity index 100% rename from "docs/zh/guide/Work/\346\272\220\347\240\201.md" rename to docs/zh/guide/Work/source-code.md diff --git "a/docs/zh/guide/WxOpen/\351\253\230\347\272\247\346\216\245\345\217\243.md" b/docs/zh/guide/WxOpen/advanced-interface.md similarity index 100% rename from "docs/zh/guide/WxOpen/\351\253\230\347\272\247\346\216\245\345\217\243.md" rename to docs/zh/guide/WxOpen/advanced-interface.md diff --git "a/docs/zh/guide/TenPayV3/\350\277\233\351\230\266.md" b/docs/zh/guide/WxOpen/advanced.md similarity index 100% rename from "docs/zh/guide/TenPayV3/\350\277\233\351\230\266.md" rename to docs/zh/guide/WxOpen/advanced.md diff --git "a/docs/zh/guide/WxOpen/\345\256\242\346\210\267\347\253\257\345\274\200\345\217\221.md" b/docs/zh/guide/WxOpen/client-development.md similarity index 100% rename from "docs/zh/guide/WxOpen/\345\256\242\346\210\267\347\253\257\345\274\200\345\217\221.md" rename to docs/zh/guide/WxOpen/client-development.md diff --git "a/docs/zh/guide/WxOpen/\350\216\267\345\217\226\346\211\213\346\234\272\345\217\267.md" b/docs/zh/guide/WxOpen/get-phone-number.md similarity index 100% rename from "docs/zh/guide/WxOpen/\350\216\267\345\217\226\346\211\213\346\234\272\345\217\267.md" rename to docs/zh/guide/WxOpen/get-phone-number.md diff --git "a/docs/zh/guide/WxOpen/\345\246\202\344\275\225\345\256\211\350\243\205.md" b/docs/zh/guide/WxOpen/install.md similarity index 100% rename from "docs/zh/guide/WxOpen/\345\246\202\344\275\225\345\256\211\350\243\205.md" rename to docs/zh/guide/WxOpen/install.md diff --git "a/docs/zh/guide/WxOpen/\347\231\273\345\275\225.md" b/docs/zh/guide/WxOpen/login.md similarity index 100% rename from "docs/zh/guide/WxOpen/\347\231\273\345\275\225.md" rename to docs/zh/guide/WxOpen/login.md diff --git "a/docs/zh/guide/WxOpen/\345\205\266\344\273\226.md" b/docs/zh/guide/WxOpen/other.md similarity index 100% rename from "docs/zh/guide/WxOpen/\345\205\266\344\273\226.md" rename to docs/zh/guide/WxOpen/other.md diff --git "a/docs/zh/guide/WxOpen/\346\263\250\345\206\214.md" b/docs/zh/guide/WxOpen/register.md similarity index 100% rename from "docs/zh/guide/WxOpen/\346\263\250\345\206\214.md" rename to docs/zh/guide/WxOpen/register.md diff --git "a/docs/zh/guide/WxOpen/\345\260\217\347\250\213\345\272\217\346\234\215\345\212\241\350\257\267\346\261\202.md" b/docs/zh/guide/WxOpen/request-service.md similarity index 100% rename from "docs/zh/guide/WxOpen/\345\260\217\347\250\213\345\272\217\346\234\215\345\212\241\350\257\267\346\261\202.md" rename to docs/zh/guide/WxOpen/request-service.md diff --git "a/docs/zh/guide/WxOpen/\346\272\220\347\240\201.md" b/docs/zh/guide/WxOpen/source-code.md similarity index 100% rename from "docs/zh/guide/WxOpen/\346\272\220\347\240\201.md" rename to docs/zh/guide/WxOpen/source-code.md diff --git "a/docs/zh/guide/\345\272\223\345\222\214\347\273\204\344\273\266.md" b/docs/zh/guide/lib.md similarity index 100% rename from "docs/zh/guide/\345\272\223\345\222\214\347\273\204\344\273\266.md" rename to docs/zh/guide/lib.md diff --git a/docs/zh/guide/release/new_function.md b/docs/zh/guide/release/new-function.md similarity index 100% rename from docs/zh/guide/release/new_function.md rename to docs/zh/guide/release/new-function.md diff --git "a/docs/zh/guide/Work/\350\277\233\351\230\266.md" b/docs/zh/guide/tenpayv2/advanced.md similarity index 100% rename from "docs/zh/guide/Work/\350\277\233\351\230\266.md" rename to docs/zh/guide/tenpayv2/advanced.md diff --git "a/docs/zh/guide/TenPayV2/\346\224\257\344\273\230\345\233\236\350\260\203.md" b/docs/zh/guide/tenpayv2/callback.md similarity index 100% rename from "docs/zh/guide/TenPayV2/\346\224\257\344\273\230\345\233\236\350\260\203.md" rename to docs/zh/guide/tenpayv2/callback.md diff --git "a/docs/zh/guide/TenPayV2/\345\246\202\344\275\225\345\256\211\350\243\205.md" b/docs/zh/guide/tenpayv2/install.md similarity index 100% rename from "docs/zh/guide/TenPayV2/\345\246\202\344\275\225\345\256\211\350\243\205.md" rename to docs/zh/guide/tenpayv2/install.md diff --git a/docs/zh/guide/TenPayV2/JASPI.md b/docs/zh/guide/tenpayv2/jssdk.md similarity index 100% rename from docs/zh/guide/TenPayV2/JASPI.md rename to docs/zh/guide/tenpayv2/jssdk.md diff --git "a/docs/zh/guide/TenPayV2/Native\346\224\257\344\273\230.md" b/docs/zh/guide/tenpayv2/nativepay.md similarity index 100% rename from "docs/zh/guide/TenPayV2/Native\346\224\257\344\273\230.md" rename to docs/zh/guide/tenpayv2/nativepay.md diff --git "a/docs/zh/guide/TenPayV2/\351\200\200\346\254\276.md" b/docs/zh/guide/tenpayv2/refund.md similarity index 100% rename from "docs/zh/guide/TenPayV2/\351\200\200\346\254\276.md" rename to docs/zh/guide/tenpayv2/refund.md diff --git "a/docs/zh/guide/TenPayV2/\346\263\250\345\206\214.md" b/docs/zh/guide/tenpayv2/register.md similarity index 100% rename from "docs/zh/guide/TenPayV2/\346\263\250\345\206\214.md" rename to docs/zh/guide/tenpayv2/register.md diff --git "a/docs/zh/guide/TenPayV2/\346\272\220\347\240\201.md" b/docs/zh/guide/tenpayv2/source-code.md similarity index 100% rename from "docs/zh/guide/TenPayV2/\346\272\220\347\240\201.md" rename to docs/zh/guide/tenpayv2/source-code.md diff --git "a/docs/zh/guide/WxOpen/\350\277\233\351\230\266.md" b/docs/zh/guide/tenpayv3/advanced.md similarity index 100% rename from "docs/zh/guide/WxOpen/\350\277\233\351\230\266.md" rename to docs/zh/guide/tenpayv3/advanced.md diff --git "a/docs/zh/guide/TenPayV3/\346\224\257\344\273\230\345\233\236\350\260\203.md" b/docs/zh/guide/tenpayv3/callback.md similarity index 100% rename from "docs/zh/guide/TenPayV3/\346\224\257\344\273\230\345\233\236\350\260\203.md" rename to docs/zh/guide/tenpayv3/callback.md diff --git "a/docs/zh/guide/TenPayV3/\345\246\202\344\275\225\345\256\211\350\243\205.md" b/docs/zh/guide/tenpayv3/install.md similarity index 100% rename from "docs/zh/guide/TenPayV3/\345\246\202\344\275\225\345\256\211\350\243\205.md" rename to docs/zh/guide/tenpayv3/install.md diff --git a/docs/zh/guide/TenPayV3/JASPI.md b/docs/zh/guide/tenpayv3/jssdk.md similarity index 100% rename from docs/zh/guide/TenPayV3/JASPI.md rename to docs/zh/guide/tenpayv3/jssdk.md diff --git "a/docs/zh/guide/TenPayV3/Native\346\224\257\344\273\230.md" b/docs/zh/guide/tenpayv3/nativepay.md similarity index 100% rename from "docs/zh/guide/TenPayV3/Native\346\224\257\344\273\230.md" rename to docs/zh/guide/tenpayv3/nativepay.md diff --git "a/docs/zh/guide/TenPayV3/\351\200\200\346\254\276.md" b/docs/zh/guide/tenpayv3/refund.md similarity index 100% rename from "docs/zh/guide/TenPayV3/\351\200\200\346\254\276.md" rename to docs/zh/guide/tenpayv3/refund.md diff --git "a/docs/zh/guide/TenPayV3/\346\263\250\345\206\214.md" b/docs/zh/guide/tenpayv3/register.md similarity index 100% rename from "docs/zh/guide/TenPayV3/\346\263\250\345\206\214.md" rename to docs/zh/guide/tenpayv3/register.md diff --git "a/docs/zh/guide/TenPayV3/\346\272\220\347\240\201.md" b/docs/zh/guide/tenpayv3/source-code.md similarity index 100% rename from "docs/zh/guide/TenPayV3/\346\272\220\347\240\201.md" rename to docs/zh/guide/tenpayv3/source-code.md diff --git a/docs/zh/release/log.md b/docs/zh/release/log.md deleted file mode 100644 index 90d89bf248..0000000000 --- a/docs/zh/release/log.md +++ /dev/null @@ -1,5 +0,0 @@ -# 日志 - -## 2023-08-12 更新 - -1.添加Docs文档功能 diff --git a/docs/zh/release/new_function.md b/docs/zh/release/new_function.md deleted file mode 100644 index 140069ba06..0000000000 --- a/docs/zh/release/new_function.md +++ /dev/null @@ -1 +0,0 @@ -# 文档模块使用事例 diff --git a/readme.en.md b/readme.en.md index d8716dd227..092122ad26 100644 --- a/readme.en.md +++ b/readme.en.md @@ -27,6 +27,31 @@ If you like and hope us to continue to optimize this project, please give us a S > ⚡ Sample has already supported for .NET 6.0, [Click Here](Samples/net6-mvc) !
> 🍦 [file.api.weixin.qq.com Domain name officially disabled(2020.9.15)](https://developers.weixin.qq.com/community/develop/doc/0002245dcdc8c06f36fa6a47d56400), please update to the latest version!
+## How to use documentation + +::: warning precondition +Requirement [Node.js](https://nodejs.org/en/) >= 8.6 +::: + +**Readings：** The Node version can be managed using NVM, Download[NVM](https://github.com/coreybutler/nvm-windows/releases)。 + +1. Install yarn using Node + + ``` bash + npm install -g yarn + ``` + +2. Installation project dependent run (project source root run) + + ``` bash + yarn install + ``` + +3. Run document project + + ``` bash + yarn docs:dev + ``` ## Start：Separate document by module diff --git a/readme.md b/readme.md index 317b58c027..a0748832ce 100644 --- a/readme.md +++ b/readme.md @@ -38,14 +38,13 @@ Senparc.Weixin SDK 是目前使用率最高的微信 .NET SDK，也是国内最 **相关阅读：** 可使用NVM管理Node版本，下载[NVM](https://github.com/coreybutler/nvm-windows/releases)。 - 1. 通过Node安装yarn ``` bash npm install -g yarn ``` -2. 安装项目依赖运行 +2. 安装项目依赖运行(项目源码根目录运行) ``` bash yarn install @@ -57,8 +56,6 @@ Senparc.Weixin SDK 是目前使用率最高的微信 .NET SDK，也是国内最 yarn docs:dev ``` - - ## 🌟 Start：分模块独立文档 模块 | 地址