From 5a71884851ddd03e938bdb4ee8d63f5069c2fc68 Mon Sep 17 00:00:00 2001 From: "chen.ma" Date: Sat, 23 Jul 2022 12:44:18 +0800 Subject: [PATCH] Official website content update --- docs/docs/community/_category_.json | 7 +++ docs/docs/community/contributor.md | 19 ++++++++ docs/docs/community/developer.md | 13 ++++++ docs/docs/community/powered-by.md | 30 ++++++++++++ .../support.md => community/sponsor.md} | 19 ++++---- docs/docs/other/contributor.md | 12 ----- .../getting-started/_category_.json | 0 .../getting-started/difference.md | 0 .../getting-started/hippo4j-adapter.md | 0 .../getting-started/hippo4j-core-alarm.md | 0 .../getting-started/hippo4j-core-start.md | 0 .../getting-started/hippo4j-server-config.md | 0 .../getting-started/hippo4j-server-start.md | 0 .../img/docsVersionDropdown.png | Bin .../getting-started/img/localeDropdown.png | Bin docs/docs/{ => user_docs}/intro.md | 0 docs/docs/{ => user_docs}/ops/_category_.json | 0 .../ops/hippo4j-server-deploy.md | 0 .../{ => user_docs}/other/_category_.json | 2 +- docs/docs/{ => user_docs}/other/group.md | 0 docs/docs/{ => user_docs}/other/issue.md | 0 .../{ => user_guide}/_category_.json | 0 docs/docs/user_docs/{ => user_guide}/alarm.md | 0 docs/docs/user_docs/{ => user_guide}/frame.md | 0 .../user_docs/{ => user_guide}/framework.md | 0 .../user_docs/{ => user_guide}/quick-start.md | 0 docs/docusaurus.config.js | 43 +++++++++++++----- docs/sidebars.js | 19 ++++++++ docs/src/pages/index.js | 2 +- 29 files changed, 132 insertions(+), 34 deletions(-) create mode 100644 docs/docs/community/_category_.json create mode 100644 docs/docs/community/contributor.md create mode 100644 docs/docs/community/developer.md create mode 100644 docs/docs/community/powered-by.md rename docs/docs/{other/support.md => community/sponsor.md} (68%) delete mode 100644 docs/docs/other/contributor.md rename docs/docs/{ => user_docs}/getting-started/_category_.json (100%) rename docs/docs/{ => user_docs}/getting-started/difference.md (100%) rename docs/docs/{ => user_docs}/getting-started/hippo4j-adapter.md (100%) rename docs/docs/{ => user_docs}/getting-started/hippo4j-core-alarm.md (100%) rename docs/docs/{ => user_docs}/getting-started/hippo4j-core-start.md (100%) rename docs/docs/{ => user_docs}/getting-started/hippo4j-server-config.md (100%) rename docs/docs/{ => user_docs}/getting-started/hippo4j-server-start.md (100%) rename docs/docs/{ => user_docs}/getting-started/img/docsVersionDropdown.png (100%) rename docs/docs/{ => user_docs}/getting-started/img/localeDropdown.png (100%) rename docs/docs/{ => user_docs}/intro.md (100%) rename docs/docs/{ => user_docs}/ops/_category_.json (100%) rename docs/docs/{ => user_docs}/ops/hippo4j-server-deploy.md (100%) rename docs/docs/{ => user_docs}/other/_category_.json (80%) rename docs/docs/{ => user_docs}/other/group.md (100%) rename docs/docs/{ => user_docs}/other/issue.md (100%) rename docs/docs/user_docs/{ => user_guide}/_category_.json (100%) rename docs/docs/user_docs/{ => user_guide}/alarm.md (100%) rename docs/docs/user_docs/{ => user_guide}/frame.md (100%) rename docs/docs/user_docs/{ => user_guide}/framework.md (100%) rename docs/docs/user_docs/{ => user_guide}/quick-start.md (100%) diff --git a/docs/docs/community/_category_.json b/docs/docs/community/_category_.json new file mode 100644 index 00000000..bcd256c9 --- /dev/null +++ b/docs/docs/community/_category_.json @@ -0,0 +1,7 @@ +{ + "label": "社区", + "position": 1, + "link": { + "type": "generated-index" + } +} diff --git a/docs/docs/community/contributor.md b/docs/docs/community/contributor.md new file mode 100644 index 00000000..e5ce5c9a --- /dev/null +++ b/docs/docs/community/contributor.md @@ -0,0 +1,19 @@ +--- +sidebar_position: 1 +--- + +# 开发者指南 + + +为了让您的 id 显示在 contributor 列表中，别忘了以下设置： + +```shell +git config --global user.name "username" +git config --global user.email "github账号邮箱" +``` + +## 开发者列表 + +您可以在 [Hippo4J](https://github.com/opengoofy/hippo4j/graphs/contributors) 和 [Hippo4J Console](https://github.com/opengoofy/hippo4j-console) 的贡献列表中找到全部的贡献者名单。 + + diff --git a/docs/docs/community/developer.md b/docs/docs/community/developer.md new file mode 100644 index 00000000..3c9c9f45 --- /dev/null +++ b/docs/docs/community/developer.md @@ -0,0 +1,13 @@ +--- +sidebar_position: 2 +--- + +# 核心开发者 + + + + + + + +

马称
陆宽
diff --git a/docs/docs/community/powered-by.md b/docs/docs/community/powered-by.md new file mode 100644 index 00000000..f55d6baa --- /dev/null +++ b/docs/docs/community/powered-by.md @@ -0,0 +1,30 @@ +--- +sidebar_position: 3 +--- + +# 采用公司 + +## 登记 + +欢迎采用了 Hippo4J 的公司在此登记，非常感谢大家对 Hippo4J 的关注和支持，这是我们前进最大的动力。 + +请按公司名 + 首页的格式在 [此处](https://github.com/opengoofy/hippo4j/issues/13) 登记。 + +## 谁在使用 Hippo4J + +共计 14+ 家公司生产接入 Hippo4J。按照公司登记时间排序。 + +- [身边云](https://serviceshare.com) +- [Medbanks](https://www.medbanks.cn) +- [北京智合联创科技有限公司](http://www.zhlc.com.cn) +- [神州数码](http://www.digitalchina.com) +- [payermax](https://www.payermax.com/) +- [轻松到家](http://www.uyess.com/index.html) +- [某商业银行股份有限公司](TODO) +- [某国际物流信息股份有限公司](TODO) +- [萨科（深圳）科技有限公司](https://www.lbdj.com/) +- [广东天枢新能源科技有限公司](https://gd-tianshu.com/) +- [FitTime](http://fittime.com/) +- [百强国际物流](TODO) +- [海南某深圳分公司](TODO) +- [众合云科（51社保）](https://home.101hr.com/) \ No newline at end of file diff --git a/docs/docs/other/support.md b/docs/docs/community/sponsor.md similarity index 68% rename from docs/docs/other/support.md rename to docs/docs/community/sponsor.md index e6c2a7fc..a8d7c081 100644 --- a/docs/docs/other/support.md +++ b/docs/docs/community/sponsor.md @@ -1,9 +1,10 @@ --- -sidebar_position: 3 +sidebar_position: 4 --- + # 支持开源 - + 如果您正在使用这个项目并感觉良好，或者是想支持我继续开发，您可以通过如下 `任意` 方式支持我： 1. Github star 并分享动态线程池框架 [hippo4j](https://github.com/longtai-cn/hippo4j) :rocket: @@ -16,12 +17,12 @@ sidebar_position: 3 | ![](https://images-machen.oss-cn-beijing.aliyuncs.com/IMG_6719_2.jpg?x-oss-process=image/resize,h_180,w_180) | ![](https://images-machen.oss-cn-beijing.aliyuncs.com/IMG_6720_3.jpg?x-oss-process=image/resize,h_180,w_180) | ### 致谢 - + 感谢给予支持的朋友，您的支持是我前进的动力 🎉 - - - | | ID | 赞赏金额 | 时间 | 备注 | + + +| | ID | 赞赏金额 | 时间 | 备注 | | ---- | ------- | ---- | ---------- | ------------------------------------ | - | 1 | 六月飞雪 | 30.00 | 2021-12-30 | 代码设计很优雅的一款框架，继续加油！ | - | 2 | 孙大圣 | 26.6 | 2022-03-23 | 学习一下😁😁 | - | 3 | Easy 点 | 66.00 | 2022-04-09 | 好货好技术当加赏 | +| 1 | 六月飞雪 | 30.00 | 2021-12-30 | 代码设计很优雅的一款框架，继续加油！ | +| 2 | 孙大圣 | 26.6 | 2022-03-23 | 学习一下😁😁 | +| 3 | Easy 点 | 66.00 | 2022-04-09 | 好货好技术当加赏 | diff --git a/docs/docs/other/contributor.md b/docs/docs/other/contributor.md deleted file mode 100644 index c7ca8544..00000000 --- a/docs/docs/other/contributor.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -sidebar_position: 4 ---- - -# 贡献者指南 - -为了让您的 id 显示在 contributor 列表中，别忘了以下设置： - -```shell script -git config --global user.name "username" -git config --global user.email "github账号邮箱" -``` diff --git a/docs/docs/getting-started/_category_.json b/docs/docs/user_docs/getting-started/_category_.json similarity index 100% rename from docs/docs/getting-started/_category_.json rename to docs/docs/user_docs/getting-started/_category_.json diff --git a/docs/docs/getting-started/difference.md b/docs/docs/user_docs/getting-started/difference.md similarity index 100% rename from docs/docs/getting-started/difference.md rename to docs/docs/user_docs/getting-started/difference.md diff --git a/docs/docs/getting-started/hippo4j-adapter.md b/docs/docs/user_docs/getting-started/hippo4j-adapter.md similarity index 100% rename from docs/docs/getting-started/hippo4j-adapter.md rename to docs/docs/user_docs/getting-started/hippo4j-adapter.md diff --git a/docs/docs/getting-started/hippo4j-core-alarm.md b/docs/docs/user_docs/getting-started/hippo4j-core-alarm.md similarity index 100% rename from docs/docs/getting-started/hippo4j-core-alarm.md rename to docs/docs/user_docs/getting-started/hippo4j-core-alarm.md diff --git a/docs/docs/getting-started/hippo4j-core-start.md b/docs/docs/user_docs/getting-started/hippo4j-core-start.md similarity index 100% rename from docs/docs/getting-started/hippo4j-core-start.md rename to docs/docs/user_docs/getting-started/hippo4j-core-start.md diff --git a/docs/docs/getting-started/hippo4j-server-config.md b/docs/docs/user_docs/getting-started/hippo4j-server-config.md similarity index 100% rename from docs/docs/getting-started/hippo4j-server-config.md rename to docs/docs/user_docs/getting-started/hippo4j-server-config.md diff --git a/docs/docs/getting-started/hippo4j-server-start.md b/docs/docs/user_docs/getting-started/hippo4j-server-start.md similarity index 100% rename from docs/docs/getting-started/hippo4j-server-start.md rename to docs/docs/user_docs/getting-started/hippo4j-server-start.md diff --git a/docs/docs/getting-started/img/docsVersionDropdown.png b/docs/docs/user_docs/getting-started/img/docsVersionDropdown.png similarity index 100% rename from docs/docs/getting-started/img/docsVersionDropdown.png rename to docs/docs/user_docs/getting-started/img/docsVersionDropdown.png diff --git a/docs/docs/getting-started/img/localeDropdown.png b/docs/docs/user_docs/getting-started/img/localeDropdown.png similarity index 100% rename from docs/docs/getting-started/img/localeDropdown.png rename to docs/docs/user_docs/getting-started/img/localeDropdown.png diff --git a/docs/docs/intro.md b/docs/docs/user_docs/intro.md similarity index 100% rename from docs/docs/intro.md rename to docs/docs/user_docs/intro.md diff --git a/docs/docs/ops/_category_.json b/docs/docs/user_docs/ops/_category_.json similarity index 100% rename from docs/docs/ops/_category_.json rename to docs/docs/user_docs/ops/_category_.json diff --git a/docs/docs/ops/hippo4j-server-deploy.md b/docs/docs/user_docs/ops/hippo4j-server-deploy.md similarity index 100% rename from docs/docs/ops/hippo4j-server-deploy.md rename to docs/docs/user_docs/ops/hippo4j-server-deploy.md diff --git a/docs/docs/other/_category_.json b/docs/docs/user_docs/other/_category_.json similarity index 80% rename from docs/docs/other/_category_.json rename to docs/docs/user_docs/other/_category_.json index 732c82f1..a74d7432 100644 --- a/docs/docs/other/_category_.json +++ b/docs/docs/user_docs/other/_category_.json @@ -1,6 +1,6 @@ { "label": "其它", - "position": 5, + "position": 6, "link": { "type": "generated-index" } diff --git a/docs/docs/other/group.md b/docs/docs/user_docs/other/group.md similarity index 100% rename from docs/docs/other/group.md rename to docs/docs/user_docs/other/group.md diff --git a/docs/docs/other/issue.md b/docs/docs/user_docs/other/issue.md similarity index 100% rename from docs/docs/other/issue.md rename to docs/docs/user_docs/other/issue.md diff --git a/docs/docs/user_docs/_category_.json b/docs/docs/user_docs/user_guide/_category_.json similarity index 100% rename from docs/docs/user_docs/_category_.json rename to docs/docs/user_docs/user_guide/_category_.json diff --git a/docs/docs/user_docs/alarm.md b/docs/docs/user_docs/user_guide/alarm.md similarity index 100% rename from docs/docs/user_docs/alarm.md rename to docs/docs/user_docs/user_guide/alarm.md diff --git a/docs/docs/user_docs/frame.md b/docs/docs/user_docs/user_guide/frame.md similarity index 100% rename from docs/docs/user_docs/frame.md rename to docs/docs/user_docs/user_guide/frame.md diff --git a/docs/docs/user_docs/framework.md b/docs/docs/user_docs/user_guide/framework.md similarity index 100% rename from docs/docs/user_docs/framework.md rename to docs/docs/user_docs/user_guide/framework.md diff --git a/docs/docs/user_docs/quick-start.md b/docs/docs/user_docs/user_guide/quick-start.md similarity index 100% rename from docs/docs/user_docs/quick-start.md rename to docs/docs/user_docs/user_guide/quick-start.md diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 62858e8b..f32df7ca 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -60,8 +60,8 @@ const config = { announcementBar: { id: 'announcementBar-1', // Increment on change // content: `⭐️ If you like hippo4j, give it a star on Gitee, thanks.`, - // content: `⭐️ 如果你喜欢 hippo4j，请在 Gitee 上给它一个 star，谢谢！`, - content: `👉 《小马哥的代码实战课》官方知识星球来啦！！！`, + content: `⭐️ 如果您喜欢 hippo4j，请在 Gitee 或 GitHub 上给它一个 star，谢谢！`, + // content: `👉 《小马哥的代码实战课》官方知识星球来啦！！！`, }, navbar: { title: 'HIPPO-4J', @@ -71,36 +71,57 @@ const config = { }, items: [ { - type: 'doc', + type: 'docSidebar', docId: 'intro', position: 'left', + sidebarId: 'user_docs', label: '文档', }, { - to: 'docs/other/group', + type: 'docSidebar', + docId: 'contributor', position: 'left', - label: '加群沟通', + sidebarId: 'community', + label: '社区', }, {to: '/blog', label: '博客', position: 'left'}, + /*{ + type: 'docSidebar', + docId: 'intro', + position: 'left', + sidebarId: 'sponsor', + hideable: true, + label: '支持开源', + },*/ { href: 'https://xiaomage.info/knowledge-planet', label: '🥇知识星球', position: 'right', - }, { + }, + /* 国际化 */ + /*{type: 'localeDropdown', position: 'right'},*/ + { href: 'http://console.hippo4j.cn/index.html', label: '控制台样例', position: 'right', }, - { + /*{ href: 'https://gitee.com/mabaiwancn/hippo4j', label: 'Gitee', position: 'right', - }, + },*/ { href: 'https://github.com/opengoofy/hippo4j', - label: 'GitHub', + className: 'header-github-link', + 'aria-label': 'GitHub repository', position: 'right', }, + + /*{ + href: 'https://github.com/opengoofy/hippo4j', + label: 'GitHub', + position: 'right', + },*/ ], }, footer: { @@ -111,7 +132,7 @@ const config = { items: [ { label: '简介', - to: '/docs/intro', + to: '/docs/user_docs/intro', }, ], }, @@ -120,7 +141,7 @@ const config = { items: [ { label: '加群沟通', - href: 'https://hippo4j.cn/docs/other/group', + href: 'https://hippo4j.cn/user_docs/docs/other/group', }, { label: '微信公众号', diff --git a/docs/sidebars.js b/docs/sidebars.js index fd342f2c..112da355 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -16,6 +16,25 @@ const sidebars = { // By default, Docusaurus generates a sidebar from the docs folder structure tutorialSidebar: [{type: 'autogenerated', dirName: '.'}], + user_docs: [ + { + type: 'autogenerated', + dirName: 'user_docs', + }, + ], + community: [ + { + type: 'autogenerated', + dirName: 'community', + }, + ], + + sponsor: [ + { + type: 'autogenerated', + dirName: 'sponsor', + }, + ], // But you can create a sidebar manually /* tutorialSidebar: [ diff --git a/docs/src/pages/index.js b/docs/src/pages/index.js index d25a6d92..557e5928 100644 --- a/docs/src/pages/index.js +++ b/docs/src/pages/index.js @@ -17,7 +17,7 @@ function HomepageHeader() {
+ to="/docs/user_docs/intro"> 快速开始 - 5min ⏱️