Skip to content

Commit

Permalink
doc: update document config
Browse files Browse the repository at this point in the history
  • Loading branch information
Ahoo-Wang committed Nov 9, 2023
1 parent 58770ca commit e053a8c
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 8 deletions.
1 change: 1 addition & 0 deletions document/docs/.vuepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import {
const GM_ID = 'G-SP6EEGK56L'

export default defineConfig(ctx => ({
base: '',
head: [
['link', {rel: 'icon', href: `/favicon.ico`}],
[
Expand Down
11 changes: 4 additions & 7 deletions document/docs/.vuepress/config/sidebar/shared.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@

import {SidebarConfigArray} from 'vuepress/config';

export function getGuideSidebar(groupA, groupB): SidebarConfigArray {
const sidebar: SidebarConfigArray = [
export function getGuideSidebar(groupA: string, groupB: string): SidebarConfigArray {
return [
{
title: groupA,
collapsable: false,
Expand Down Expand Up @@ -68,12 +68,10 @@ export function getGuideSidebar(groupA, groupB): SidebarConfigArray {
]
}
]

return sidebar
}

export function getConfigSidebar(groupA): SidebarConfigArray {
const sidebar: SidebarConfigArray = [
export function getConfigSidebar(groupA: string): SidebarConfigArray {
return [
{
title: groupA,
collapsable: false,
Expand All @@ -87,5 +85,4 @@ export function getConfigSidebar(groupA): SidebarConfigArray {
]
}
]
return sidebar
}
2 changes: 1 addition & 1 deletion document/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ heroImage: /logo.png
heroText: CosId
tagline: 通用、灵活、高性能分布式ID生成器
actionText: 快速上手 →
actionLink: /guide/
actionLink: /guide/getting-started
features:
- title: 通用
details: 支持多种类型的分布式ID算法:SnowflakeId、SegmentId、SegmentChainId。 并且支持多种号段分发器、机器号分发器。
Expand Down

0 comments on commit e053a8c

Please sign in to comment.