Merge branch 'master' of https://git.lotus-wallet.com/Loki/zsw-docs

README.md

@@ -1,41 +1,10 @@
-# Website
-
-This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
-
-### Installation
-
-```
-$ yarn
-```
-
-### Local Development
-
-```
-$ yarn start
-```
-
-This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
-
-### Build
-
-```
-$ yarn build
-```
-
-This command generates static content into the `build` directory and can be served using any static contents hosting service.
-
-### Deployment
-
-Using SSH:
-
-```
-$ USE_SSH=true yarn deploy
-```
-
-Not using SSH:
-
-```
-$ GIT_USER=<Your GitHub username> yarn deploy
-```
-
-If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
+# 文档系统
+
+- 使用git克隆检出
+- npm i 安装依赖
+- npm start启动
+- 支持热更新
+- 图片请放在文档目录下对应的images目录，并维护好目录顺序
+- 请尽量注意格式 使用英文翻译命名
+- 文档长期更新 共同参与
+- 博客和单页暂时不动

docs/app/start.md

@@ -0,0 +1,6 @@
+---
+sidebar_position: 0
+sidebar_label: App
+title: App
+---
+## 回乡平台端设置

docs/app/test.md

@@ -0,0 +1,6 @@
+---
+sidebar_position: 0
+sidebar_label: 开始
+title: 开始
+---
+## 回乡平台端设置

docs/bxg/start.md

@@ -0,0 +1,6 @@
+---
+sidebar_position: 0
+sidebar_label: 一心回乡小程序后台
+title: 一心回乡小程序后台
+---
+## **一心回乡小程序后台**

docs/intro.md

@@ -1,12 +0,0 @@
----
-sidebar_position: 1
-sidebar_label: 帮助首页
----
-
-## 页面帮助
-
-```
-正文从这里开始
-```
-
-[页面顶部标签集合](https://docusaurus.io/zh-CN/docs/api/plugins/@docusaurus/plugin-content-docs#sidebar_label)

docs/odoo/start.md

@@ -0,0 +1,9 @@
+---
+sidebar_position: 0
+sidebar_label: Odoo
+title: Odoo
+---
+## **Odoo**
+Odoo 是基于 Python 写的一系列开源商业应用程序套装，前身是 OpenERP。
+
+此套装可满足中小型企业的一切应用需求，例如，企业基本的进销存、采购、销售、MRP 生产制造、品保质量保障、企业招聘、员工合同、休假、午餐管理、内部论坛、车队管理、内部聊天 IM 沟通、客诉追溯管理、CRM 客户关系管理、VOIP、E-Shop 电子商务、网店、企业官方网站，财务会计、银行对账、资产管理、HR 工资管理、预算管理、WMS 仓库库存管理、POS 街边小摊、社区商店、项目管理、条码、PLM 等等

docs/zsw/intro.md

@@ -0,0 +1,31 @@
+---
+sidebar_position: 1
+sidebar_label: 帮助首页
+title: 帮助
+---
+
+## 开始
+
+
+- 使用git克隆检出
+```
+git clone https://git.lotus-wallet.com/Loki/zsw-docs.git
+```
+- npm i 
+- npm start，本地调试，编写过程支持热更新
+- 发布前用serve命令确认文档可以在线上正常构建
+```
+npm run serve -- --build --port 3000 --host 0.0.0.0
+```
+
+- 图片请放在文档目录下对应的images目录，并维护好目录顺序
+- 请尽量注意格式 使用英文翻译命名
+- 使用问题：小璇兰东  格式及规范：黄婷
+- 文档长期更新 共同参与
+
+
+### 官方帮助文档
+
+[标签集合](https://docusaurus.io/zh-CN/docs/api/plugins/@docusaurus/plugin-content-docs#sidebar_label) 
+
+[github](https://github.com/facebook/docusaurus.git)

docusaurus.config.js

@@ -6,8 +6,8 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula');
 
 /** @type {import('@docusaurus/types').Config} */
 const config = {
-  title: '文档',
-  tagline: 'power by 恐龙',
+  title: '回乡文档',
+  // tagline: 'power by 恐龙',
   favicon: 'img/favicon.ico',
 
   // Set the production url of your site here
@@ -37,20 +37,20 @@ const config = {
       'classic',
       /** @type {import('@docusaurus/preset-classic').Options} */
       ({
-        // docs: {
-        //   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/zyh/docs',
-        // },
-        // blog: {
-        //   showReadingTime: true,
-        //   // Please change this to your repo.
-        //   // Remove this to remove the "edit this page" links.
-        //   editUrl:
-        //     'https://git.lotus-wallet.com/zyh/docs',
-        // },
+        docs: {
+          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',
+        },
+        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',
+        },
         theme: {
           customCss: require.resolve('./src/css/custom.css'),
         },
@@ -64,7 +64,7 @@ const config = {
       // Replace with your project's social card
       image: 'img/docusaurus-social-card.jpg',
       navbar: {
-        title: '回乡门店软件运营文档',
+        title: '回乡信息-软件使用文档',
         logo: {
           alt: 'Log',
           src: 'img/logo.svg',
@@ -72,16 +72,38 @@ const config = {
         items: [
           {
             type: 'docSidebar',
-            sidebarId: 'defaultSidebar',
+            sidebarId: 'tenantSidebar',
+            position: 'left',
+            label: '回乡商家端',
+          },
+
+          {
+            type: 'docSidebar',
+            sidebarId: 'appSidebar',
+            position: 'left',
+            label: '回乡App管理端',
+          },
+
+          {
+            type: 'docSidebar',
+            sidebarId: 'odooSidebar',
             position: 'left',
-            label: '开始',
+            label: 'Odoo操作指南',
+          },
+
+          {
+            type: 'docSidebar',
+            sidebarId: 'bxgSidebar',
+            position: 'left',
+            label: '一心回乡小程序',
+          },
+
+          // {to: '/blog', label: 'Blog', position: 'left'},
+          {
+            href: 'http://www.yixinhuixiang.com',
+            label: '一心回乡',
+            position: 'right',
           },
-          {to: '/blog', label: 'Blog', position: 'left'},
-          // {
-          //   href: 'https://github.com/facebook/docusaurus',
-          //   label: 'GitHub',
-          //   position: 'right',
-          // },
         ],
       },
       footer: {
@@ -91,8 +113,16 @@ const config = {
             title: '帮助',
             items: [
               {
-                label: '开始',
-                to: '/docs/intro',
+                label: '回乡门店',
+                to: '/docs/zsw/intro',
+              },
+              {
+                label: '回乡APP',
+                to: '/docs/app/start',
+              },
+              {
+                label: 'Odoo',
+                to: '/docs/odoo/start',
               },
             ],
           },

sidebars.js

@@ -13,21 +13,31 @@
 
 /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
 const sidebars = {
-  // By default, Docusaurus generates a sidebar from the docs folder structure
-  tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
 
-  // But you can create a sidebar manually
-  /*
-  tutorialSidebar: [
-    'intro',
-    'hello',
+  tenantSidebar: [
     {
-      type: 'category',
-      label: 'Tutorial',
-      items: ['tutorial-basics/create-a-document'],
+      type: 'autogenerated',
+      dirName: 'zsw'
+    },
+  ],
+  appSidebar: [
+    {
+      type: 'autogenerated',
+      dirName: 'app',
+    },
+  ],
+  odooSidebar: [
+    {
+      type: 'autogenerated',
+      dirName: 'odoo',
+    },
+  ],
+  bxgSidebar: [
+    {
+      type: 'autogenerated',
+      dirName: 'bxg',
     },
   ],
-   */
 };
 
 module.exports = sidebars;

src/pages/index.js

@@ -17,8 +17,8 @@ function HomepageHeader() {
         <div className={styles.buttons}>
           <Link
             className="button button--secondary button--lg"
-            to="/docs/intro">
-            Docusaurus 教程 - 5分钟 ⏱️
+            to="/docs/zsw/intro">
+            门店后台文档 ⏱️
           </Link>
         </div>
       </div>