From aa3c636a7aaf28c356f4ac62b9f04945f15d9bf5 Mon Sep 17 00:00:00 2001 From: Shinigami92 Date: Fri, 9 Sep 2022 10:17:24 +0200 Subject: [PATCH 1/2] docs: fix links and anchors --- docs/api/ApiIndex.vue | 2 +- scripts/apidoc/apiDocsWriter.ts | 11 ++++++----- scripts/apidoc/moduleMethods.ts | 4 ++++ 3 files changed, 11 insertions(+), 6 deletions(-) diff --git a/docs/api/ApiIndex.vue b/docs/api/ApiIndex.vue index 0846d9f258d..f191a555b72 100644 --- a/docs/api/ApiIndex.vue +++ b/docs/api/ApiIndex.vue @@ -84,7 +84,7 @@ function slugify(text: string): string { diff --git a/scripts/apidoc/apiDocsWriter.ts b/scripts/apidoc/apiDocsWriter.ts index 991932429f4..102ffc76b6f 100644 --- a/scripts/apidoc/apiDocsWriter.ts +++ b/scripts/apidoc/apiDocsWriter.ts @@ -5,7 +5,7 @@ import { ReflectionKind } from 'typedoc'; import type { Method } from '../../docs/.vitepress/components/api-docs/method'; import type { APIGroup, APIItem } from '../../docs/api/api-types'; import { selectDirectMethods } from './directMethods'; -import { extractModuleName, selectApiModules } from './moduleMethods'; +import { extractModuleName, selectApiModules, slugify } from './moduleMethods'; import type { PageIndex } from './utils'; import { formatMarkdown, @@ -167,16 +167,17 @@ export function writeApiSearchIndex(project: ProjectReflection): void { moduleApiSection.items = [...apiModules, ...directMethods] .map((module) => { + const moduleName = extractModuleName(module); const apiSection: APIItem = { - text: extractModuleName(module), - link: module.name.toLowerCase(), + text: moduleName, + link: moduleName.toLowerCase(), headers: [], }; if (module.kind !== ReflectionKind.Property) { apiSection.headers = module .getChildrenByKind(ReflectionKind.Method) .map((child) => ({ - anchor: child.name, + anchor: slugify(child.name), text: child.name, })); } else { @@ -187,7 +188,7 @@ export function writeApiSearchIndex(project: ProjectReflection): void { apiSection.headers = [ { - anchor: module.name, + anchor: slugify(module.name), text: module.name, }, ]; diff --git a/scripts/apidoc/moduleMethods.ts b/scripts/apidoc/moduleMethods.ts index 08da17ef47b..4cf5748c5f5 100644 --- a/scripts/apidoc/moduleMethods.ts +++ b/scripts/apidoc/moduleMethods.ts @@ -49,6 +49,10 @@ function extractModuleFieldName(module: DeclarationReflection): string { return moduleName.substring(0, 1).toLowerCase() + moduleName.substring(1); } +export function slugify(value: string): string { + return value.toLowerCase().replace(/\_/g, '-'); +} + /** * Analyzes and writes the documentation for a module and its methods such as `faker.animal.cat()`. * From d69562f34655993b53260a2945c946832e594757 Mon Sep 17 00:00:00 2001 From: Shinigami92 Date: Fri, 9 Sep 2022 10:42:18 +0200 Subject: [PATCH 2/2] docs: fix links and anchors --- docs/api/ApiIndex.vue | 4 ++-- scripts/apidoc/apiDocsWriter.ts | 6 +++--- scripts/apidoc/moduleMethods.ts | 4 ---- 3 files changed, 5 insertions(+), 9 deletions(-) diff --git a/docs/api/ApiIndex.vue b/docs/api/ApiIndex.vue index f191a555b72..ec9c752e981 100644 --- a/docs/api/ApiIndex.vue +++ b/docs/api/ApiIndex.vue @@ -55,8 +55,8 @@ function slugify(text: string): string { .replace(/^\-+|\-+$/g, '') // ensure it doesn't start with a number (like #123) .replace(/^(\d)/, '_$1') - // // lowercase - // .toLowerCase() + // lowercase + .toLowerCase() ); } diff --git a/scripts/apidoc/apiDocsWriter.ts b/scripts/apidoc/apiDocsWriter.ts index 102ffc76b6f..42b8f6c4f39 100644 --- a/scripts/apidoc/apiDocsWriter.ts +++ b/scripts/apidoc/apiDocsWriter.ts @@ -5,7 +5,7 @@ import { ReflectionKind } from 'typedoc'; import type { Method } from '../../docs/.vitepress/components/api-docs/method'; import type { APIGroup, APIItem } from '../../docs/api/api-types'; import { selectDirectMethods } from './directMethods'; -import { extractModuleName, selectApiModules, slugify } from './moduleMethods'; +import { extractModuleName, selectApiModules } from './moduleMethods'; import type { PageIndex } from './utils'; import { formatMarkdown, @@ -177,7 +177,7 @@ export function writeApiSearchIndex(project: ProjectReflection): void { apiSection.headers = module .getChildrenByKind(ReflectionKind.Method) .map((child) => ({ - anchor: slugify(child.name), + anchor: child.name, text: child.name, })); } else { @@ -188,7 +188,7 @@ export function writeApiSearchIndex(project: ProjectReflection): void { apiSection.headers = [ { - anchor: slugify(module.name), + anchor: module.name, text: module.name, }, ]; diff --git a/scripts/apidoc/moduleMethods.ts b/scripts/apidoc/moduleMethods.ts index 4cf5748c5f5..08da17ef47b 100644 --- a/scripts/apidoc/moduleMethods.ts +++ b/scripts/apidoc/moduleMethods.ts @@ -49,10 +49,6 @@ function extractModuleFieldName(module: DeclarationReflection): string { return moduleName.substring(0, 1).toLowerCase() + moduleName.substring(1); } -export function slugify(value: string): string { - return value.toLowerCase().replace(/\_/g, '-'); -} - /** * Analyzes and writes the documentation for a module and its methods such as `faker.animal.cat()`. *