msb-public
/
hippo4j
mirror of https://github.com/longtai-cn/hippo4j
1
0
Code Issues Projects Releases Wiki Activity

Update doc (#1399)

Browse Source 
* Update docs

* Update users.md
pull/1402/head
magestack 12 months ago committed by GitHub
parent 41514383bf
commit 8c8205b552
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 200 additions and 198 deletions
Show Stats Download Patch File Download Diff File

388
docs/docusaurus.config.js
Unescape View File

@ -6,215 +6,211 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula');
/** @type {import('@docusaurus/types').Config} */ /** @type {import('@docusaurus/types').Config} */
const config = { const config = {
title: 'Hippo4j', title: 'Hippo4j',
tagline: '动态可观测线程池框架，为业务系统提高线上运行保障能力', tagline: '动态可观测线程池框架，为业务系统提高线上运行保障能力',
url: 'https://hippo4j.cn', url: 'https://hippo4j.cn',
baseUrl: '/', baseUrl: '/',
onBrokenLinks: 'throw', onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn', onBrokenMarkdownLinks: 'warn',
favicon: 'img/hippo4j_favicon.ico', favicon: 'img/hippo4j_favicon.ico',
// GitHub pages deployment config. // GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these. // If you aren't using GitHub pages, you don't need these.
organizationName: 'hippo4j', // Usually your GitHub org/user name. organizationName: 'hippo4j', // Usually your GitHub org/user name.
projectName: 'hippo4j.github.io', // Usually your repo name. projectName: 'hippo4j.github.io', // Usually your repo name.
deploymentBranch: 'main', deploymentBranch: 'main',
// Even if you don't use internalization, you can use this field to set useful // Even if you don't use internalization, you can use this field to set useful
// metadata like html lang. For example, if your site is Chinese, you may want // metadata like html lang. For example, if your site is Chinese, you may want
// to replace "en" with "zh-Hans". // to replace "en" with "zh-Hans".
i18n: { i18n: {
defaultLocale: 'en', defaultLocale: 'en',
locales: ['en', 'zh'], locales: ['en', 'zh'],
localeConfigs: { localeConfigs: {
en: { en: {
label: 'English', label: 'English',
direction: 'ltr', direction: 'ltr',
}, },
zh: { zh: {
label: '简体中文', label: '简体中文',
direction: 'ltr', direction: 'ltr',
}, },
},
}, },
},
presets: [ presets: [
[ [
'classic', 'classic',
/** @type {import('@docusaurus/preset-classic').Options} */ /** @type {import('@docusaurus/preset-classic').Options} */
({ ({
docs: { docs: {
sidebarPath: require.resolve('./sidebars.js'), sidebarPath: require.resolve('./sidebars.js'),
// Please change this to your repo. // Please change this to your repo.
// Remove this to remove the "edit this page" links. // Remove this to remove the "edit this page" links.
sidebarCollapsed: false, sidebarCollapsed: false,
/*editUrl: 'https://github.com/longtai-cn',*/ /*editUrl: 'https://github.com/longtai-cn',*/
}, },
blog: { blog: {
showReadingTime: true, showReadingTime: true,
// Please change this to your repo. // Please change this to your repo.
// Remove this to remove the "edit this page" links. // Remove this to remove the "edit this page" links.
editUrl: editUrl:
'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/', 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
}, },
theme: { theme: {
customCss: require.resolve('./src/css/custom.css'), customCss: require.resolve('./src/css/custom.css'),
}, },
}), }),
],
], ],
],
plugins: [ plugins: [
[ [
'@docusaurus/plugin-content-docs', '@docusaurus/plugin-content-docs',
{ {
id: 'community', id: 'community',
path: 'community', path: 'community',
routeBasePath: 'community', routeBasePath: 'community',
sidebarPath: require.resolve('./sidebarsCommunity.js'), sidebarPath: require.resolve('./sidebarsCommunity.js'),
}, },
],
], ],
],
themeConfig: themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */ /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({ ({
autoCollapseCategories: true, autoCollapseCategories: true,
announcementBar: { announcementBar: {
id: 'announcementBar-1', // Increment on change id: 'announcementBar-1', // Increment on change
// content: `⭐️ If you like hippo4j, give it a star on <a target="_blank" rel="noopener noreferrer" href="https://gitee.com/mabaiwancn/hippo4j">Gitee</a>, thanks.`, // content: `⭐️ If you like hippo4j, give it a star on <a target="_blank" rel="noopener noreferrer" href="https://gitee.com/mabaiwancn/hippo4j">Gitee</a>, thanks.`,
// content: `⭐️ 如果您喜欢 hippo4j，请在 <a target="_blank" rel="noopener noreferrer" href="https://gitee.com/mabaiwancn/hippo4j">Gitee</a> 和 <a target="_blank" rel="noopener noreferrer" href="https://github.com/opengoofy/hippo4j">GitHub</a> 上给它一个 star，谢谢！`, // content: `⭐️ 如果您喜欢 hippo4j，请在 <a target="_blank" rel="noopener noreferrer" href="https://gitee.com/mabaiwancn/hippo4j">Gitee</a> 和 <a target="_blank" rel="noopener noreferrer" href="https://github.com/opengoofy/hippo4j">GitHub</a> 上给它一个 star，谢谢！`,
content: `⭐️ 开源不易，如果 Hippo4j 对您有帮助，请在 <a target="_blank" rel="noopener noreferrer" href="https://github.com/opengoofy/hippo4j">GitHub</a> 上给它一个 Star 🌟`, content: `⭐️ 开源不易，如果 Hippo4j 对您有帮助，请在 <a target="_blank" rel="noopener noreferrer" href="https://github.com/opengoofy/hippo4j">GitHub</a> 上给它一个 Star 🌟`,
// content: `<a target="_blank" rel="noopener noreferrer" href="https://xiaomage.info/knowledge-planet/">👉 《小马哥的代码实战课》官方知识星球来啦！！！</a>`, // content: `<a target="_blank" rel="noopener noreferrer" href="https://xiaomage.info/knowledge-planet/">👉 《小马哥的代码实战课》官方知识星球来啦！！！</a>`,
}, },
navbar: { navbar: {
title: '', title: '',
logo: { logo: {
alt: 'Hippo4j 动态可观测线程池框架', alt: 'Hippo4j 动态可观测线程池框架',
src: 'img/hippo4j.png', src: 'img/hippo4j.png',
}, },
items: [ items: [
{ {
type: 'docSidebar', type: 'docSidebar',
docId: 'intro', docId: 'intro',
position: 'left', position: 'left',
sidebarId: 'user_docs', sidebarId: 'user_docs',
label: '文档', label: '文档',
}, },
{ {
to: '/community/contributor-guide', to: '/community/contributor-guide',
label: '社区', label: '社区',
position: 'left', position: 'left',
activeBaseRegex: `/community/`, activeBaseRegex: `/community/`,
}, },
/*{ to: "/team", label: "团队", position: "left" },*/ /*{ to: "/team", label: "团队", position: "left" },*/
{ to: '/users', label: '采用公司', position: 'left' }, {to: '/users', label: '采用公司', position: 'left'},
{ to: '/group', label: '加群沟通', position: 'left' }, {to: '/group', label: '加群沟通', position: 'left'},
/*{to: '/blog', label: '博客', position: 'left'},*/ /*{to: '/blog', label: '博客', position: 'left'},*/
{ {
href: 'http://console.hippo4j.cn/index.html', href: 'http://console.hippo4j.cn/index.html',
label: '控制台样例', label: '控制台样例',
position: 'left', position: 'left',
}, },
{ {
href: 'https://gitee.com/opengoofy/congomall', href: 'https://magestack.cn',
label: '👉 刚果商城', label: '🚀 拿个offer',
position: 'left', position: 'left',
}, },
{ {
type: 'docsVersionDropdown', type: 'docsVersionDropdown',
position: 'right',
dropdownActiveClassDisabled: true,
},
{ type: 'localeDropdown', position: 'right' },
/*{
href: 'https://gitee.com/mabaiwancn/hippo4j',
label: 'Gitee',
position: 'right', position: 'right',
},*/ dropdownActiveClassDisabled: true,
{ },
href: 'https://github.com/opengoofy/hippo4j',
className: 'header-github-link',
'aria-label': 'GitHub repository',
position: 'right',
},
/*{ {type: 'localeDropdown', position: 'right'},
/*{
href: 'https://gitee.com/mabaiwancn/hippo4j',
label: 'Gitee',
position: 'right',
},*/
{
href: 'https://github.com/opengoofy/hippo4j', href: 'https://github.com/opengoofy/hippo4j',
label: 'GitHub', className: 'header-github-link',
'aria-label': 'GitHub repository',
position: 'right', position: 'right',
},*/ },
],
}, /*{
footer: { href: 'https://github.com/opengoofy/hippo4j',
style: 'dark', label: 'GitHub',
links: [ position: 'right',
{ },*/
title: 'Docs', ],
items: [ },
{ footer: {
label: 'Intro', style: 'dark',
to: '/docs/user_docs/intro', links: [
}, {
{ title: 'Docs',
label: 'Config Mode', items: [
to: '/docs/user_docs/getting_started/config/hippo4j-config-start', {
}, label: 'Intro',
{ to: '/docs/user_docs/intro',
label: 'Server Mode', },
to: '/docs/user_docs/getting_started/server/hippo4j-server-start', {
}, label: 'Config Mode',
], to: '/docs/user_docs/getting_started/config/hippo4j-config-start',
}, },
{ {
title: 'Community', label: 'Server Mode',
items: [ to: '/docs/user_docs/getting_started/server/hippo4j-server-start',
{ },
label: 'Group', ],
href: 'https://hippo4j.cn/group', },
}, {
{ title: 'Community',
label: 'WeChat', items: [
href: 'https://mp.weixin.qq.com/s/diVHYvwiuYH9aWpZDPc27g', {
}, label: 'Group',
], href: 'https://hippo4j.cn/group',
}, },
{ {
title: 'More', label: 'WeChat',
items: [ href: 'https://mp.weixin.qq.com/s/diVHYvwiuYH9aWpZDPc27g',
{ },
label: 'Gitee', ],
href: 'https://gitee.com/opengoofy/hippo4j', },
}, {
{ title: 'More',
label: 'GitHub', items: [
href: 'https://github.com/opengoofy/hippo4j', {
}, label: 'Gitee',
], href: 'https://gitee.com/opengoofy/hippo4j',
}, },
{ {
title: 'Links', label: 'GitHub',
items: [ href: 'https://github.com/opengoofy/hippo4j',
{ },
label: '书源', ],
href: 'https://bookyuan.cn/', },
}, {
{ title: 'Links',
label: '推广合作', items: [
href: 'https://hippo4j.cn/docs/user_docs/other/operation', {
}, label: '推广合作',
], href: 'https://hippo4j.cn/docs/user_docs/other/operation',
}, },
], ],
copyright: `Copyright © 2021-2022 马丁版权所有 <a href="https://beian.miit.gov.cn">京ICP备2021038095号 },
],
copyright: `Copyright © 2021-2023 马丁版权所有 <a href="https://beian.miit.gov.cn">京ICP备2021038095号
</a>`, </a>`,
}, },
prism: { prism: {
theme: lightCodeTheme, theme: lightCodeTheme,
darkTheme: darkCodeTheme, darkTheme: darkCodeTheme,
additionalLanguages: ['java'], additionalLanguages: ['java'],
}, },
}), }),
}; };
module.exports = config; module.exports = config;

5
docs/i18n/zh/docusaurus-plugin-content-pages/users.md
Unescape View File

@ -5,7 +5,7 @@ title: 采用公司
## 谁在使用 Hippo4j ## 谁在使用 Hippo4j
共计 39+ 家公司生产接入 Hippo4j，按照公司登记时间排序。 共计 42+ 家公司生产接入 Hippo4j，按照公司登记时间排序。
- [身边云](https://serviceshare.com) - [身边云](https://serviceshare.com)
- [思派健康科技](https://www.medbanks.cn) - [思派健康科技](https://www.medbanks.cn)
@ -46,6 +46,9 @@ title: 采用公司
- [广联达科技股份有限公司](https://www.glodon.com) - [广联达科技股份有限公司](https://www.glodon.com)
- [天健联创控股集团有限公司](https://www.tjlc.com.cn) - [天健联创控股集团有限公司](https://www.tjlc.com.cn)
- [知乎](https://www.zhihu.com/) - [知乎](https://www.zhihu.com/)
- [广东谷通科技有限公司](https://www.duofriend.com)
- [成都全域智旅科技有限公司](http://qyzl.com)
- [深圳市华云中盛科技股份有限公司](http://www.hua-cloud.cn)
## 登记 ## 登记

5
docs/src/pages/users.md
Unescape View File

@ -5,7 +5,7 @@ title: 采用公司
## 谁在使用 Hippo4j ## 谁在使用 Hippo4j
共计 39+ 家公司生产接入 Hippo4j，按照公司登记时间排序。 共计 42+ 家公司生产接入 Hippo4j，按照公司登记时间排序。
- [身边云](https://serviceshare.com) - [身边云](https://serviceshare.com)
- [思派健康科技](https://www.medbanks.cn) - [思派健康科技](https://www.medbanks.cn)
@ -46,6 +46,9 @@ title: 采用公司
- [广联达科技股份有限公司](https://www.glodon.com) - [广联达科技股份有限公司](https://www.glodon.com)
- [天健联创控股集团有限公司](https://www.tjlc.com.cn) - [天健联创控股集团有限公司](https://www.tjlc.com.cn)
- [知乎](https://www.zhihu.com/) - [知乎](https://www.zhihu.com/)
- [广东谷通科技有限公司](https://www.duofriend.com)
- [成都全域智旅科技有限公司](http://qyzl.com)
- [深圳市华云中盛科技股份有限公司](http://www.hua-cloud.cn)
## 登记 ## 登记

Write Preview
Loading…
Cancel
Save