chore(core): updated docs

Author: tgreyuk

.changeset/big-teachers-shave.md

@@ -4,4 +4,4 @@
 
 - Implemented typedoc 0.27 compatibility support.
 - Exposed "typeDeclarationVisibility" option to provide a compacted output structure (#703).
-- The "textContentMappings" option now accepts a string with placeholder or a function with arguments (#693, #715).
+- Exposed "pageTitleTemplates" option that accepts a string with placeholder or function arguments to control page titles. Should be used in favour of "textContentMapping" (#693, #715).

.changeset/chatty-cheetahs-love.md

@@ -2,4 +2,4 @@
 'typedoc-plugin-markdown': minor
 ---
 
-- Exposed formatting with prettier options (--formatWithPrettier and --prettierConfigFile).
+- Exposed formatting with prettier options "formatWithPrettier" and "prettierConfigFile" that enables additional formatting of output if Prettier is installed on a project.

.github/workflows/ci.yml

@@ -16,15 +16,15 @@ on:
 jobs:
   lint-and-test:
     runs-on: ubuntu-latest
+    timeout-minutes: 30
     strategy:
+      fail-fast: false
       matrix:
         node: ['20']
+        include:
+          - retry: [1, 2, 3]
     name: Node ${{ matrix.node }}
     steps:
-      - name: Set Swap Space
-        uses: pierotofy/set-swap-space@master
-        with:
-          swap-size-gb: 10
       - name: Checkout repository
         uses: actions/checkout@v4
       - name: Set up Node

devtools/packages/prebuild-options/tasks/generate-models.ts

@@ -66,7 +66,6 @@ import { ManuallyValidatedOption } from 'typedoc'`);
         theme_default_value: [];
         theme_default_type: [];
         theme_description: [];
-        theme_documentation: [];
         theme_event: [];
         theme_re_exports: [];
         theme_renames_and_re_exports: [];
@@ -134,7 +133,7 @@ ${name}: ${getType(name, option, true)};`,
       ${Object.entries(option.defaultValue as any)
         .map(
           ([key, value]) =>
-            `'${key}'${value === undefined ? '?' : ''}: ${getValueType(value)}`,
+            `'${key}'${value === undefined ? '?' : ''}: ${getValueType(key, value)}`,
         )
         .join(';')}
   }
@@ -161,7 +160,14 @@ function getComments(name: string) {
   return '';
 }
 
-function getValueType(value: any) {
+function getValueType(key: string, value: any) {
+  if (key === 'pageTitleTemplates') {
+    return `{
+    index: string | ((args: { name: string }) => string);
+    member: string;
+    module: string;
+  }`;
+  }
   if (value === true || value === false) {
     return 'boolean';
   }
@@ -179,6 +185,13 @@ function getType(
   option: Partial<DeclarationOption>,
   isInterface = false,
 ) {
+  if (name === 'pageTitleTemplates') {
+    return `{
+    index: string | ((name: { projectName: string; version: string }) => string);
+    member: string | ((name: { name: string; kind: string; group: string }) => string);
+    module: string | ((name: { name: string, kind: string }) => string);
+  }`;
+  }
   if (option.type === ParameterType.Array && option.defaultValue?.length) {
     return `(${option.defaultValue
       .toString()

devtools/typedoc-plugins/typedoc-default-values.js renamed to devtools/typedoc-plugins/typedoc-default-values.mjs

@@ -1,7 +1,6 @@
-const { Converter, TypeScript, CommentTag, Comment } = require('typedoc');
-const { ModifierFlags } = require('typescript');
+import { Comment, CommentTag, Converter, TypeScript } from 'typedoc';
 
-exports.load = function (app) {
+export function load(app) {
   const printer = TypeScript.createPrinter({
     removeComments: false,
     omitTrailingSemicolon: true,
@@ -32,7 +31,7 @@ exports.load = function (app) {
 
         reflection.defaultValue = '';
 
-        if (Boolean(reflection.comment)) {
+        if (reflection.comment) {
           reflection.comment.blockTags = [
             ...(reflection.comment.blockTags || []),
             getTag(defaultValue),
@@ -43,7 +42,7 @@ exports.load = function (app) {
       }
     },
   );
-};
+}
 function getTag(value) {
   return new CommentTag('@defaultValue', [
     {

devtools/typedoc-plugins/typedoc-symbols.mjs

@@ -1,7 +1,15 @@
+// @ts-check
+
+/**
+ * Local plugin to tweak TypeDoc output for nextra docs
+ *
+ *  @param {import("typedoc").Application} app
+ */
 export function load(app) {
   app.converter.addUnknownSymbolResolver((ref) => {
     if (ref.moduleSource === 'typedoc') {
-      const symbol = ref.symbolReference.path[0].path;
+      const symbol =
+        ref?.symbolReference?.path && ref?.symbolReference?.path[0].path;
       const enums = ['ReflectionKind'];
       const configuration = [
         'DeclarationOption',
@@ -56,24 +64,28 @@ export function load(app) {
         'QueryType',
       ];
 
-      if (models.includes(symbol)) {
-        return `https://typedoc.org/api/classes/Models.${symbol}.html`;
-      }
-      if (classes.includes(symbol)) {
-        return `https://typedoc.org/api/classes/${symbol}.html`;
-      }
-      if (enums.includes(symbol)) {
-        return `https://typedoc.org/api/enums/Models.${symbol}-1.html`;
-      }
-      if (interfaces.includes(symbol)) {
-        return `https://typedoc.org/api/${interfaces}/TypeDocOptions.html`;
-      }
-      if (configuration.includes(symbol)) {
-        return `https://typedoc.org/api/types/Configuration.${symbol}.html`;
-      }
-      if (types.includes(symbol)) {
-        return `https://typedoc.org/api/types/${symbol}.DeclarationOption.html`;
+      if (symbol) {
+        if (models.includes(symbol)) {
+          return `https://typedoc.org/api/classes/Models.${symbol}.html`;
+        }
+        if (classes.includes(symbol)) {
+          return `https://typedoc.org/api/classes/${symbol}.html`;
+        }
+        if (enums.includes(symbol)) {
+          return `https://typedoc.org/api/enums/Models.${symbol}-1.html`;
+        }
+        if (interfaces.includes(symbol)) {
+          return `https://typedoc.org/api/${interfaces}/TypeDocOptions.html`;
+        }
+        if (configuration.includes(symbol)) {
+          return `https://typedoc.org/api/types/Configuration.${symbol}.html`;
+        }
+        if (types.includes(symbol)) {
+          return `https://typedoc.org/api/types/${symbol}.DeclarationOption.html`;
+        }
       }
+
+      return '';
     }
   });
 }

docs/pages/api-docs/Class.MarkdownPageEvent.mdx

@@ -57,6 +57,14 @@ The complete `string` filename where the file will be written..
 
 ***
 
+### group?
+
+> `optional` **group**: `string`
+
+The group that the reflection belongs too
+
+***
+
 ### contents?
 
 > `optional` **contents**: `string`