feat: Added generator text to content mappings.

typedoc2md · Jan 14, 2024 · 62f0eac · 62f0eac
1 parent 4c6fe80
commit 62f0eac
Show file tree

Hide file tree

Showing 7 changed files with 29 additions and 2 deletions.
diff --git a/docs/pages/options.mdx b/docs/pages/options.mdx
@@ -400,6 +400,7 @@ Below is the full list of keys and default values:
     "header.readme": "Readme",
     "header.docs": "API",
     "breadcrumbs.home": "{projectName}",
+    "footer.generator": "Generated using TypeDoc and typedoc-plugin-markdown.",
     "title.indexPage": "{projectName} {version}",
     "title.modulePage": "{name}",
     "title.memberPage": "{kind}: {name}",

diff --git a/packages/typedoc-plugin-markdown/src/options/maps.ts b/packages/typedoc-plugin-markdown/src/options/maps.ts
@@ -30,6 +30,7 @@ export const StaticText = {
   'header.readme': 'Readme',
   'header.docs': 'API',
   'breadcrumbs.home': '{projectName}',
+  'footer.generator': 'Generated using TypeDoc and typedoc-plugin-markdown.',
   'title.indexPage': '{projectName} {version}',
   'title.modulePage': '{name}',
   'title.memberPage': '{kind}: {name}',

diff --git a/packages/typedoc-plugin-markdown/src/options/models.ts b/packages/typedoc-plugin-markdown/src/options/models.ts
@@ -61,6 +61,7 @@ export interface TextContentMappings {
   'header.readme': string;
   'header.docs': string;
   'breadcrumbs.home': string;
+  'footer.generator': string;
   'title.indexPage': string;
   'title.modulePage': string;
   'title.memberPage': string;

diff --git a/packages/typedoc-plugin-markdown/src/theme/resources/partials/footer.ts b/packages/typedoc-plugin-markdown/src/theme/resources/partials/footer.ts
@@ -6,7 +6,14 @@ import { horizontalRule } from '../../../support/elements';
  */
 export function footer(context: MarkdownThemeRenderContext): string {
   if (!context.options.getValue('hideGenerator')) {
-    return `${horizontalRule()}Generated using [typedoc-plugin-markdown](https://www.npmjs.com/package/typedoc-plugin-markdown) and [TypeDoc](https://typedoc.org/)`;
+    const generatorText = context
+      .getTextContent('footer.generator')
+      ?.replace(/TypeDoc/g, '[TypeDoc](https://typedoc.org)')
+      .replace(
+        /typedoc-plugin-markdown/g,
+        '[typedoc-plugin-markdown](https://typedoc-plugin-markdown.org)',
+      );
+    return [horizontalRule(), generatorText].join('');
   }
   return '';
 }
diff --git a/packages/typedoc-plugin-markdown/test/__utils__/fixture-config.ts b/packages/typedoc-plugin-markdown/test/__utils__/fixture-config.ts
@@ -149,7 +149,7 @@ export const FIXTURES: Fixture[] = [
   {
     outDir: FixtureOutputDir.Text,
     entryPoints: FixtureEntryPoints.Text,
-    commonOptions: { hideGenerator: true, disableSources: true },
+    commonOptions: { disableSources: true },
     options: [
       {
         includeVersion: true,

diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/text.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/text.spec.ts.snap
@@ -11,6 +11,10 @@ exports[`Text should get translations for index page: (Output File Strategy "mem
 
 - [module-1](module-1/README.md)
 - [module-2](module-2/README.md)
+
+***
+
+@copyright My Test
 "
 `;
 
@@ -34,6 +38,10 @@ exports[`Text should get translations for member page: (Output File Strategy "me
 | Event! | Type |
 | :------ | :------ |
 | \`someEvent\` | \`MouseEvent\` |
+
+***
+
+@copyright My Test
 "
 `;
 
@@ -51,6 +59,10 @@ exports[`Text should get translations for module page: (Output File Strategy "me
 ### 多变的
 
 - [SomeInterface](interfaces/SomeInterface.md)
+
+***
+
+@copyright My Test
 "
 `;
 
@@ -68,5 +80,9 @@ exports[`Text should get translations for modules page: (Output File Strategy "m
 ### Variable: constA
 
 > **\`const\`** **constA**: \`true\` = \`true\`
+
+***
+
+@copyright My Test
 "
 `;
diff --git a/stubs/typedoc.text.cjs b/stubs/typedoc.text.cjs
@@ -7,6 +7,7 @@ module.exports = {
     'header.readme': 'My Readme',
     'header.docs': 'Docs',
     'breadcrumbs.home': 'Home',
+    'footer.generator': '@copyright My Test',
     'title.indexPage': ':tada: Custom Index Title',
     'title.memberPage': '{name}',
     'title.member': '{kind}: {name}',