diff --git a/README.md b/README.md index aaba2fa..be41c58 100644 --- a/README.md +++ b/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= 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目录，并维护好目录顺序 +- 请尽量注意格式 使用英文翻译命名 +- 文档长期更新 共同参与 +- 博客和单页暂时不动 \ No newline at end of file diff --git a/docs/app/start.md b/docs/app/start.md new file mode 100644 index 0000000..49cd577 --- /dev/null +++ b/docs/app/start.md @@ -0,0 +1,6 @@ +--- +sidebar_position: 0 +sidebar_label: App +title: App +--- +## 回乡平台端设置 \ No newline at end of file diff --git a/docs/app/test.md b/docs/app/test.md new file mode 100644 index 0000000..57049a5 --- /dev/null +++ b/docs/app/test.md @@ -0,0 +1,6 @@ +--- +sidebar_position: 0 +sidebar_label: 开始 +title: 开始 +--- +## 回乡平台端设置 \ No newline at end of file diff --git a/docs/bxg/start.md b/docs/bxg/start.md new file mode 100644 index 0000000..de0f98c --- /dev/null +++ b/docs/bxg/start.md @@ -0,0 +1,6 @@ +--- +sidebar_position: 0 +sidebar_label: 一心回乡小程序后台 +title: 一心回乡小程序后台 +--- +## **一心回乡小程序后台** diff --git a/docs/intro.md b/docs/intro.md deleted file mode 100644 index eaba73c..0000000 --- a/docs/intro.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -sidebar_position: 1 -sidebar_label: 帮助首页 ---- - -## 页面帮助 - -``` -正文从这里开始 -``` - -[页面顶部标签集合](https://docusaurus.io/zh-CN/docs/api/plugins/@docusaurus/plugin-content-docs#sidebar_label) diff --git a/docs/odoo/start.md b/docs/odoo/start.md new file mode 100644 index 0000000..f3c32b3 --- /dev/null +++ b/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 等等 \ No newline at end of file diff --git a/docs/banner_settings.md b/docs/zsw/banner_settings.md similarity index 100% rename from docs/banner_settings.md rename to docs/zsw/banner_settings.md diff --git a/docs/cashier_system/_category_.json b/docs/zsw/cashier_system/_category_.json similarity index 100% rename from docs/cashier_system/_category_.json rename to docs/zsw/cashier_system/_category_.json diff --git a/docs/cashier_system/img/image-1.png b/docs/zsw/cashier_system/img/image-1.png similarity index 100% rename from docs/cashier_system/img/image-1.png rename to docs/zsw/cashier_system/img/image-1.png diff --git a/docs/cashier_system/img/image-2.png b/docs/zsw/cashier_system/img/image-2.png similarity index 100% rename from docs/cashier_system/img/image-2.png rename to docs/zsw/cashier_system/img/image-2.png diff --git a/docs/cashier_system/img/image-3.png b/docs/zsw/cashier_system/img/image-3.png similarity index 100% rename from docs/cashier_system/img/image-3.png rename to docs/zsw/cashier_system/img/image-3.png diff --git a/docs/cashier_system/img/image-4.png b/docs/zsw/cashier_system/img/image-4.png similarity index 100% rename from docs/cashier_system/img/image-4.png rename to docs/zsw/cashier_system/img/image-4.png diff --git a/docs/cashier_system/img/image-5.png b/docs/zsw/cashier_system/img/image-5.png similarity index 100% rename from docs/cashier_system/img/image-5.png rename to docs/zsw/cashier_system/img/image-5.png diff --git a/docs/cashier_system/img/image.png b/docs/zsw/cashier_system/img/image.png similarity index 100% rename from docs/cashier_system/img/image.png rename to docs/zsw/cashier_system/img/image.png diff --git a/docs/cashier_system/img/image1.png b/docs/zsw/cashier_system/img/image1.png similarity index 100% rename from docs/cashier_system/img/image1.png rename to docs/zsw/cashier_system/img/image1.png diff --git a/docs/cashier_system/img/image7.png b/docs/zsw/cashier_system/img/image7.png similarity index 100% rename from docs/cashier_system/img/image7.png rename to docs/zsw/cashier_system/img/image7.png diff --git a/docs/cashier_system/inventory.md b/docs/zsw/cashier_system/inventory.md similarity index 100% rename from docs/cashier_system/inventory.md rename to docs/zsw/cashier_system/inventory.md diff --git a/docs/cashier_system/login.md b/docs/zsw/cashier_system/login.md similarity index 100% rename from docs/cashier_system/login.md rename to docs/zsw/cashier_system/login.md diff --git a/docs/cashier_system/order process.md b/docs/zsw/cashier_system/order process.md similarity index 100% rename from docs/cashier_system/order process.md rename to docs/zsw/cashier_system/order process.md diff --git a/docs/coupon.md b/docs/zsw/coupon.md similarity index 100% rename from docs/coupon.md rename to docs/zsw/coupon.md diff --git a/docs/goods/_category_.json b/docs/zsw/goods/_category_.json similarity index 100% rename from docs/goods/_category_.json rename to docs/zsw/goods/_category_.json diff --git a/docs/goods/details.md b/docs/zsw/goods/details.md similarity index 100% rename from docs/goods/details.md rename to docs/zsw/goods/details.md diff --git a/docs/goods/img/details1.png b/docs/zsw/goods/img/details1.png similarity index 100% rename from docs/goods/img/details1.png rename to docs/zsw/goods/img/details1.png diff --git a/docs/goods/img/details2.png b/docs/zsw/goods/img/details2.png similarity index 100% rename from docs/goods/img/details2.png rename to docs/zsw/goods/img/details2.png diff --git a/docs/goods/img/good.dat b/docs/zsw/goods/img/good.dat similarity index 100% rename from docs/goods/img/good.dat rename to docs/zsw/goods/img/good.dat diff --git a/docs/goods/img/image.png b/docs/zsw/goods/img/image.png similarity index 100% rename from docs/goods/img/image.png rename to docs/zsw/goods/img/image.png diff --git a/docs/goods/img/spec1.dat b/docs/zsw/goods/img/spec1.dat similarity index 100% rename from docs/goods/img/spec1.dat rename to docs/zsw/goods/img/spec1.dat diff --git a/docs/goods/img/spec2.dat b/docs/zsw/goods/img/spec2.dat similarity index 100% rename from docs/goods/img/spec2.dat rename to docs/zsw/goods/img/spec2.dat diff --git a/docs/goods/img/spec3.png b/docs/zsw/goods/img/spec3.png similarity index 100% rename from docs/goods/img/spec3.png rename to docs/zsw/goods/img/spec3.png diff --git a/docs/goods/img/spec4.png b/docs/zsw/goods/img/spec4.png similarity index 100% rename from docs/goods/img/spec4.png rename to docs/zsw/goods/img/spec4.png diff --git a/docs/goods/info.md b/docs/zsw/goods/info.md similarity index 100% rename from docs/goods/info.md rename to docs/zsw/goods/info.md diff --git a/docs/goods/spec.md b/docs/zsw/goods/spec.md similarity index 100% rename from docs/goods/spec.md rename to docs/zsw/goods/spec.md diff --git a/docs/gusangyuan.md b/docs/zsw/gusangyuan.md similarity index 100% rename from docs/gusangyuan.md rename to docs/zsw/gusangyuan.md diff --git a/docs/img/banner1.png b/docs/zsw/img/banner1.png similarity index 100% rename from docs/img/banner1.png rename to docs/zsw/img/banner1.png diff --git a/docs/img/banner2.png b/docs/zsw/img/banner2.png similarity index 100% rename from docs/img/banner2.png rename to docs/zsw/img/banner2.png diff --git a/docs/img/cm1.png b/docs/zsw/img/cm1.png similarity index 100% rename from docs/img/cm1.png rename to docs/zsw/img/cm1.png diff --git a/docs/img/cm2.png b/docs/zsw/img/cm2.png similarity index 100% rename from docs/img/cm2.png rename to docs/zsw/img/cm2.png diff --git a/docs/img/cm3.png b/docs/zsw/img/cm3.png similarity index 100% rename from docs/img/cm3.png rename to docs/zsw/img/cm3.png diff --git a/docs/img/cm4.png b/docs/zsw/img/cm4.png similarity index 100% rename from docs/img/cm4.png rename to docs/zsw/img/cm4.png diff --git a/docs/img/cm5.png b/docs/zsw/img/cm5.png similarity index 100% rename from docs/img/cm5.png rename to docs/zsw/img/cm5.png diff --git a/docs/img/cm7.png b/docs/zsw/img/cm7.png similarity index 100% rename from docs/img/cm7.png rename to docs/zsw/img/cm7.png diff --git a/docs/img/gsy-1.png b/docs/zsw/img/gsy-1.png similarity index 100% rename from docs/img/gsy-1.png rename to docs/zsw/img/gsy-1.png diff --git a/docs/img/gsy-2.png b/docs/zsw/img/gsy-2.png similarity index 100% rename from docs/img/gsy-2.png rename to docs/zsw/img/gsy-2.png diff --git a/docs/img/gsy-3.png b/docs/zsw/img/gsy-3.png similarity index 100% rename from docs/img/gsy-3.png rename to docs/zsw/img/gsy-3.png diff --git a/docs/img/image-1.png b/docs/zsw/img/image-1.png similarity index 100% rename from docs/img/image-1.png rename to docs/zsw/img/image-1.png diff --git a/docs/img/image.png b/docs/zsw/img/image.png similarity index 100% rename from docs/img/image.png rename to docs/zsw/img/image.png diff --git a/docs/img/image10.png b/docs/zsw/img/image10.png similarity index 100% rename from docs/img/image10.png rename to docs/zsw/img/image10.png diff --git a/docs/img/image3.png b/docs/zsw/img/image3.png similarity index 100% rename from docs/img/image3.png rename to docs/zsw/img/image3.png diff --git a/docs/img/image4.png b/docs/zsw/img/image4.png similarity index 100% rename from docs/img/image4.png rename to docs/zsw/img/image4.png diff --git a/docs/img/image5.png b/docs/zsw/img/image5.png similarity index 100% rename from docs/img/image5.png rename to docs/zsw/img/image5.png diff --git a/docs/img/image6.png b/docs/zsw/img/image6.png similarity index 100% rename from docs/img/image6.png rename to docs/zsw/img/image6.png diff --git a/docs/img/image7.png b/docs/zsw/img/image7.png similarity index 100% rename from docs/img/image7.png rename to docs/zsw/img/image7.png diff --git a/docs/img/image8.png b/docs/zsw/img/image8.png similarity index 100% rename from docs/img/image8.png rename to docs/zsw/img/image8.png diff --git a/docs/img/image9.png b/docs/zsw/img/image9.png similarity index 100% rename from docs/img/image9.png rename to docs/zsw/img/image9.png diff --git a/docs/img/login.dat b/docs/zsw/img/login.dat similarity index 100% rename from docs/img/login.dat rename to docs/zsw/img/login.dat diff --git a/docs/img/msj.png b/docs/zsw/img/msj.png similarity index 100% rename from docs/img/msj.png rename to docs/zsw/img/msj.png diff --git a/docs/img/msj1.png b/docs/zsw/img/msj1.png similarity index 100% rename from docs/img/msj1.png rename to docs/zsw/img/msj1.png diff --git a/docs/img/msj2.png b/docs/zsw/img/msj2.png similarity index 100% rename from docs/img/msj2.png rename to docs/zsw/img/msj2.png diff --git a/docs/img/msj3.png b/docs/zsw/img/msj3.png similarity index 100% rename from docs/img/msj3.png rename to docs/zsw/img/msj3.png diff --git a/docs/img/msj4.png b/docs/zsw/img/msj4.png similarity index 100% rename from docs/img/msj4.png rename to docs/zsw/img/msj4.png diff --git a/docs/img/msj5.png b/docs/zsw/img/msj5.png similarity index 100% rename from docs/img/msj5.png rename to docs/zsw/img/msj5.png diff --git a/docs/img/msj6.png b/docs/zsw/img/msj6.png similarity index 100% rename from docs/img/msj6.png rename to docs/zsw/img/msj6.png diff --git a/docs/img/msj7.png b/docs/zsw/img/msj7.png similarity index 100% rename from docs/img/msj7.png rename to docs/zsw/img/msj7.png diff --git a/docs/img/order1.png b/docs/zsw/img/order1.png similarity index 100% rename from docs/img/order1.png rename to docs/zsw/img/order1.png diff --git a/docs/img/order5.png b/docs/zsw/img/order5.png similarity index 100% rename from docs/img/order5.png rename to docs/zsw/img/order5.png diff --git a/docs/img/ques-1.png b/docs/zsw/img/ques-1.png similarity index 100% rename from docs/img/ques-1.png rename to docs/zsw/img/ques-1.png diff --git a/docs/img/ques-2.png b/docs/zsw/img/ques-2.png similarity index 100% rename from docs/img/ques-2.png rename to docs/zsw/img/ques-2.png diff --git a/docs/img/ques-3.png b/docs/zsw/img/ques-3.png similarity index 100% rename from docs/img/ques-3.png rename to docs/zsw/img/ques-3.png diff --git a/docs/img/ques-4.png b/docs/zsw/img/ques-4.png similarity index 100% rename from docs/img/ques-4.png rename to docs/zsw/img/ques-4.png diff --git a/docs/img/ques.png b/docs/zsw/img/ques.png similarity index 100% rename from docs/img/ques.png rename to docs/zsw/img/ques.png diff --git a/docs/img/sts3.png b/docs/zsw/img/sts3.png similarity index 100% rename from docs/img/sts3.png rename to docs/zsw/img/sts3.png diff --git a/docs/zsw/intro.md b/docs/zsw/intro.md new file mode 100644 index 0000000..05c9e49 --- /dev/null +++ b/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) \ No newline at end of file diff --git a/docs/login.md b/docs/zsw/login.md similarity index 100% rename from docs/login.md rename to docs/zsw/login.md diff --git a/docs/order.md b/docs/zsw/order.md similarity index 100% rename from docs/order.md rename to docs/zsw/order.md diff --git a/docs/product _catalog.md b/docs/zsw/product _catalog.md similarity index 100% rename from docs/product _catalog.md rename to docs/zsw/product _catalog.md diff --git a/docs/promotion.md b/docs/zsw/promotion.md similarity index 100% rename from docs/promotion.md rename to docs/zsw/promotion.md diff --git a/docs/ques_tickets.md b/docs/zsw/ques_tickets.md similarity index 100% rename from docs/ques_tickets.md rename to docs/zsw/ques_tickets.md diff --git a/docs/store_settings.md b/docs/zsw/store_settings.md similarity index 100% rename from docs/store_settings.md rename to docs/zsw/store_settings.md diff --git a/docusaurus.config.js b/docusaurus.config.js index 503eb49..04f862f 100644 --- a/docusaurus.config.js +++ b/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', }, ], }, diff --git a/sidebars.js b/sidebars.js index 9ab54c2..7525ade 100644 --- a/sidebars.js +++ b/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; diff --git a/src/pages/index.js b/src/pages/index.js index f482b9f..06d0e9a 100644 --- a/src/pages/index.js +++ b/src/pages/index.js @@ -17,8 +17,8 @@ function HomepageHeader() {
- Docusaurus 教程 - 5分钟 ⏱️ + to="/docs/zsw/intro"> + 门店后台文档 ⏱️