From 34cd4491191ef287d6ee46f07f1a20b39bb6fa28 Mon Sep 17 00:00:00 2001 From: Shinigami Date: Wed, 17 Aug 2022 01:19:52 +0800 Subject: docs: update vitepress (#1276) --- docs/.vitepress/config.ts | 6 +++--- docs/about/team/members.json | 7 ++++++- package.json | 2 +- pnpm-lock.yaml | 8 ++++---- test/scripts/apidoc/signature.expected.json | 28 ++++++++++++++-------------- 5 files changed, 28 insertions(+), 23 deletions(-) diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index bc5117b5..44a1ec79 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -158,9 +158,9 @@ export default defineConfig({ { text: 'Announcements', link: '/about/announcements', - // children: [ - // { text: '2022-01-14', link: '/about/announcements/2022-01-14' }, - // ], + items: [ + { text: '2022-01-14', link: '/about/announcements/2022-01-14' }, + ], }, { text: 'Team', diff --git a/docs/about/team/members.json b/docs/about/team/members.json index 7732eab2..bd94e8fb 100644 --- a/docs/about/team/members.json +++ b/docs/about/team/members.json @@ -70,7 +70,12 @@ "desc": "", "links": [ { "icon": "github", "link": "https://github.com/griest024" }, - { "icon": "gitlab", "link": "https://gitlab.com/griest" } + { + "icon": { + "svg": "" + }, + "link": "https://gitlab.com/griest" + } ] }, { diff --git a/package.json b/package.json index dcad45e0..245a09db 100644 --- a/package.json +++ b/package.json @@ -132,7 +132,7 @@ "typescript": "~4.7.4", "validator": "~13.7.0", "vite": "~3.0.7", - "vitepress": "1.0.0-alpha.4", + "vitepress": "1.0.0-alpha.5", "vitest": "~0.21.1" }, "packageManager": "pnpm@7.9.0", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 2f9e1952..ced76822 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -40,7 +40,7 @@ specifiers: typescript: ~4.7.4 validator: ~13.7.0 vite: ~3.0.7 - vitepress: 1.0.0-alpha.4 + vitepress: 1.0.0-alpha.5 vitest: ~0.21.1 devDependencies: @@ -83,7 +83,7 @@ devDependencies: typescript: 4.7.4 validator: 13.7.0 vite: 3.0.7 - vitepress: 1.0.0-alpha.4_bnoix7udcyfzum3bz5llzjedt4 + vitepress: 1.0.0-alpha.5_bnoix7udcyfzum3bz5llzjedt4 vitest: 0.21.1_sehv5z2ska3ro4ilvbpiw5dgiy packages: @@ -4850,8 +4850,8 @@ packages: fsevents: 2.3.2 dev: true - /vitepress/1.0.0-alpha.4_bnoix7udcyfzum3bz5llzjedt4: - resolution: {integrity: sha512-bOAA4KW6vYGlkbcrPLZLTKWTgXVroObU+o9xj9EENyEl6yg26WWvfN7DGA4BftjdM5O8nR93Z5khPQ3W/tFE7Q==} + /vitepress/1.0.0-alpha.5_bnoix7udcyfzum3bz5llzjedt4: + resolution: {integrity: sha512-bhUfmTzd+i5fm2rInBR1Q/1RBhT0xTXM+vPqVWJdHmIc8XnWF/O7lT6kai38rOTNTt/KyPDk2SRRourPVhQJMA==} engines: {node: '>=14.6.0'} hasBin: true dependencies: diff --git a/test/scripts/apidoc/signature.expected.json b/test/scripts/apidoc/signature.expected.json index fc948e55..1e59fb57 100644 --- a/test/scripts/apidoc/signature.expected.json +++ b/test/scripts/apidoc/signature.expected.json @@ -12,7 +12,7 @@ } ], "returns": "number", - "examples": "
faker.defaultBooleanParamMethod(c: boolean = true): number\n
\n
", + "examples": "
ts
faker.defaultBooleanParamMethod(c: boolean = true): number\n
\n
", "deprecated": false, "seeAlsos": [] }, @@ -28,7 +28,7 @@ } ], "returns": "number", - "examples": "
faker.functionParamMethod(fn: (a: string) => number): number\n
\n
", + "examples": "
ts
faker.functionParamMethod(fn: (a: string) => number): number\n
\n
", "deprecated": false, "seeAlsos": [] }, @@ -44,7 +44,7 @@ } ], "returns": "string", - "examples": "
faker.literalUnionParamMethod(value: 'a' | 'b' | string): string\n
\n
", + "examples": "
ts
faker.literalUnionParamMethod(value: 'a' | 'b' | string): string\n
\n
", "deprecated": false, "seeAlsos": [] }, @@ -54,7 +54,7 @@ "description": "

Test with deprecated and see marker.

\n", "parameters": [], "returns": "number", - "examples": "
faker.methodWithDeprecated(): number\n
\n
", + "examples": "
ts
faker.methodWithDeprecated(): number\n
\n
", "deprecated": true, "seeAlsos": ["test.apidoc.methodWithExample()"] }, @@ -64,7 +64,7 @@ "description": "

Test with example marker.

\n", "parameters": [], "returns": "number", - "examples": "
faker.methodWithExample(): number\ntest.apidoc.methodWithExample() // 0\n
\n
", + "examples": "
ts
faker.methodWithExample(): number\ntest.apidoc.methodWithExample() // 0\n
\n
", "deprecated": false, "seeAlsos": [] }, @@ -91,7 +91,7 @@ } ], "returns": "number", - "examples": "
faker.multiParamMethod(a: number, b?: string, c: boolean = true): number\n
\n
", + "examples": "
ts
faker.multiParamMethod(a: number, b?: string, c: boolean = true): number\n
\n
", "deprecated": false, "seeAlsos": [] }, @@ -101,7 +101,7 @@ "description": "

Test with no parameters.

\n", "parameters": [], "returns": "number", - "examples": "
faker.noParamMethod(): number\n
\n
", + "examples": "
ts
faker.noParamMethod(): number\n
\n
", "deprecated": false, "seeAlsos": [] }, @@ -117,7 +117,7 @@ } ], "returns": "number", - "examples": "
faker.optionalStringParamMethod(b?: string): number\n
\n
", + "examples": "
ts
faker.optionalStringParamMethod(b?: string): number\n
\n
", "deprecated": false, "seeAlsos": [] }, @@ -161,7 +161,7 @@ } ], "returns": "number", - "examples": "
faker.optionsInlineParamMethodWithDefaults(a: {\n  value: number\n} = { value: 1 }, b: {\n  value: number\n} = { value: 1 }, c: {\n  value: number\n}): number\n
\n
", + "examples": "
ts
faker.optionsInlineParamMethodWithDefaults(a: {\n  value: number\n} = { value: 1 }, b: {\n  value: number\n} = { value: 1 }, c: {\n  value: number\n}): number\n
\n
", "deprecated": false, "seeAlsos": [] }, @@ -189,7 +189,7 @@ } ], "returns": "number", - "examples": "
faker.optionsInterfaceParamMethodWithDefaults(a: ParameterOptionsInterfaceA = { value: 1 }, b: ParameterOptionsInterfaceB = { value: 1 }, c: ParameterOptionsInterfaceC): number\n
\n
", + "examples": "
ts
faker.optionsInterfaceParamMethodWithDefaults(a: ParameterOptionsInterfaceA = { value: 1 }, b: ParameterOptionsInterfaceB = { value: 1 }, c: ParameterOptionsInterfaceC): number\n
\n
", "deprecated": false, "seeAlsos": [] }, @@ -225,7 +225,7 @@ } ], "returns": "number", - "examples": "
faker.optionsParamMethod(options: {\n  a: number,\n  b: string,\n  c: boolean,\n  d: () => string\n}): number\n
\n
", + "examples": "
ts
faker.optionsParamMethod(options: {\n  a: number,\n  b: string,\n  c: boolean,\n  d: () => string\n}): number\n
\n
", "deprecated": false, "seeAlsos": [] }, @@ -253,7 +253,7 @@ } ], "returns": "number", - "examples": "
faker.optionsTypeParamMethodWithDefaults(a: ParameterOptionsTypeA = { value: 1 }, b: ParameterOptionsTypeB = { value: 1 }, c: ParameterOptionsTypeC): number\n
\n
", + "examples": "
ts
faker.optionsTypeParamMethodWithDefaults(a: ParameterOptionsTypeA = { value: 1 }, b: ParameterOptionsTypeB = { value: 1 }, c: ParameterOptionsTypeC): number\n
\n
", "deprecated": false, "seeAlsos": [] }, @@ -269,7 +269,7 @@ } ], "returns": "number", - "examples": "
faker.requiredNumberParamMethod(a: number): number\n
\n
", + "examples": "
ts
faker.requiredNumberParamMethod(a: number): number\n
\n
", "deprecated": false, "seeAlsos": [] }, @@ -285,7 +285,7 @@ } ], "returns": "string", - "examples": "
faker.stringUnionParamMethod(value: 'a' | 'b'): string\n
\n
", + "examples": "
ts
faker.stringUnionParamMethod(value: 'a' | 'b'): string\n
\n
", "deprecated": false, "seeAlsos": [] } -- cgit v1.2.3