fix: removed deprecated options.

.changeset/four-bugs-fail.md

@@ -0,0 +1,5 @@
+---
+"typedoc-plugin-markdown": patch
+---
+
+- Removed deprecated options.

docs/pages/api-docs/Interface.PluginOptions.md

@@ -92,14 +92,6 @@ Do not print breadcrumbs.
 
 ***
 
-### hideInPageTOC
-
-> **hideInPageTOC**: `boolean`
-
-Do not render in-page TOC items.
-
-***
-
 ### hidePageHeader
 
 > **hidePageHeader**: `boolean`

docs/pages/docs/options.mdx

@@ -297,54 +297,6 @@ Ignored if `flattenOutputFiles` is set to `true`.
 
 ---
 
-### ~hideInPageTOC~
-
-<Callout type="warning">
-  Deprecated - In-page TOC is now hidden as default.
-</Callout>
-
-> Accepts a boolean value. Defaults to `false`.
-
-```json filename="typedoc.json"
-{
-  "hideInPageTOC": false
-}
-```
-
----
-
-### ~indexPageTitle~
-
-<Callout type="warning">Deprecated - Please use `textContentMappings`.</Callout>
-
-> Accepts a string value. Defaults to `"{ProjectName}"`.
-
-Provides a mechanism to change the main project index page title.
-
-```json filename="typedoc.json"
-{
-  "indexPageTitle": "{ProjectName}"
-}
-```
-
----
-
-### ~memberPageTitle~
-
-<Callout type="warning">Deprecated - Please use `textContentMappings`.</Callout>
-
-> Accepts a string value. Defaults to `"{kind}: {name}"`.
-
-Provides a mechanism to configure the page title of members.
-
-```json filename="typedoc.json"
-{
-  "memberPageTitle": "{kind}: {name}"
-}
-```
-
----
-
 ### excludeGroups
 
 <Callout emoji="💡">

packages/typedoc-plugin-markdown/src/options/declarations.ts

@@ -251,44 +251,6 @@ export const hideBreadcrumbs: Partial<DeclarationOption> = {
   defaultValue: false,
 };
 
-/**
- * @deprecated In-page TOC is now hidden as default.
- *
- * @category UX
- */
-export const hideInPageTOC: Partial<DeclarationOption> = {
-  help: 'Do not render in-page TOC items.',
-  type: ParameterType.Boolean,
-  defaultValue: false,
-};
-
-/**
- * Provides a mechanism to change the main project index page title.
- *
- * @deprecated Please use `textContentMappings`.
- *
- * @category UX
- *
- */
-export const indexPageTitle: Partial<DeclarationOption> = {
-  help: 'The title of project index page.',
-  type: ParameterType.String,
-  defaultValue: '{ProjectName}',
-};
-
-/**
- * Provides a mechanism to configure the page title of members.
- *
- * @deprecated Please use `textContentMappings`.
- *
- * @category UX
- */
-export const memberPageTitle: Partial<DeclarationOption> = {
-  help: 'The page title of member pages.',
-  type: ParameterType.String,
-  defaultValue: '{kind}: {name}',
-};
-
 /**
  * By default members are grouped by kind (eg Classes, Functions etc).
  *

packages/typedoc-plugin-markdown/src/options/option-types.ts

@@ -15,12 +15,9 @@ declare module 'typedoc' {
     fileExtension: string;
     flattenOutputFiles: boolean;
     hideBreadcrumbs: boolean;
-    hideInPageTOC: boolean;
     hidePageHeader: boolean;
     hidePageTitle: boolean;
     indexFormat: 'list' | 'table';
-    indexPageTitle: string;
-    memberPageTitle: string;
     membersWithOwnFile: (
       | 'Enum'
       | 'Variable'
@@ -109,11 +106,6 @@ export interface PluginOptions {
    */
   hideBreadcrumbs: boolean;
 
-  /**
-   * Do not render in-page TOC items.
-   */
-  hideInPageTOC: boolean;
-
   /**
    * Do not print page header.
    */
@@ -129,16 +121,6 @@ export interface PluginOptions {
    */
   indexFormat: 'list' | 'table';
 
-  /**
-   * The title of project index page.
-   */
-  indexPageTitle: string;
-
-  /**
-   * The page title of member pages.
-   */
-  memberPageTitle: string;
-
   /**
    * Determines which members are exported to their own file when `outputFileStrategy` equals `members`.
    */

packages/typedoc-plugin-markdown/src/theme/resources/partials/page.pageTtitle.ts

@@ -8,9 +8,7 @@ import { MarkdownThemeContext, TextContentMappings } from '../../..';
 export function pageTitle(this: MarkdownThemeContext): string {
   const page = this.page;
   if (page.model?.url === page.project.url) {
-    const titleContent = this.options.isSet('indexPageTitle')
-      ? this.options.getValue('indexPageTitle')
-      : this.getText('title.indexPage');
+    const titleContent = this.getText('title.indexPage');
     return titleContent
       .replace('{projectName}', page.project.name)
       .replace(
@@ -26,9 +24,7 @@ export function pageTitle(this: MarkdownThemeContext): string {
   const textContent =
     page.model.kind === ReflectionKind.Module
       ? this.getText('title.modulePage')
-      : this.options.isSet('memberPageTitle')
-        ? this.options.getValue('memberPageTitle')
-        : this.getText('title.memberPage');
+      : this.getText('title.memberPage');
 
   const kindKey = SINGULAR_KIND_KEY_MAP[
     ReflectionKind.singularString(page.model.kind)

packages/typedoc-plugin-markdown/test/fixtures/config.ts

@@ -20,7 +20,6 @@ const config: Record<string, Fixture> = {
         enumMembersFormat: 'table',
         useCodeBlocks: true,
         expandParameters: true,
-        memberPageTitle: '{name}',
         navigationModel: {
           excludeGroups: true,
         },
@@ -90,7 +89,6 @@ const config: Record<string, Fixture> = {
         excludeGroups: true,
         useHTMLAnchors: true,
         indexFormat: 'table',
-        indexPageTitle: '{projectName}',
         categorizeByGroup: false,
       },
     ],
@@ -135,7 +133,6 @@ const config: Record<string, Fixture> = {
         excludeScopesInPaths: true,
         mergeReadme: true,
         includeVersion: true,
-        indexPageTitle: 'API',
         indexFormat: 'table',
       },
     ],

packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.class.spec.ts.snap

@@ -49,7 +49,7 @@ Comments for abstractMethod
 `;
 
 exports[`Class Reflection should compile abstract class: (Output File Strategy "members") (Option Group "2") 1`] = `
-"# \`abstract\` AbstractClass
+"# Class: \`abstract\` AbstractClass
 
 ## Extended by
 
@@ -140,7 +140,7 @@ Comments for method
 `;
 
 exports[`Class Reflection should compile basic class: (Output File Strategy "members") (Option Group "2") 1`] = `
-"# BasicClass
+"# Class: BasicClass
 
 Comments for BasicClass
 
@@ -264,7 +264,7 @@ Param comments
 `;
 
 exports[`Class Reflection should compile class with accessors: (Output File Strategy "members") (Option Group "2") 1`] = `
-"# ClassWithAccessors
+"# Class: ClassWithAccessors
 
 Comments for ClassWithAccessors
 
@@ -400,7 +400,7 @@ Comments for someProp
 `;
 
 exports[`Class Reflection should compile class with complex props: (Output File Strategy "members") (Option Group "2") 1`] = `
-"# ClassWithComplexProps
+"# Class: ClassWithComplexProps
 
 Comments for ClassWithComplexProps
 
@@ -490,7 +490,7 @@ Comments for x string
 `;
 
 exports[`Class Reflection should compile class with constructor overloads: (Output File Strategy "members") (Option Group "2") 1`] = `
-"# ClassWithConstructorOverloads
+"# Class: ClassWithConstructorOverloads
 
 Comments for ClassWithConstructorOverloads
 
@@ -633,7 +633,7 @@ Comment for ClassWithFlags
 `;
 
 exports[`Class Reflection should compile class with flags: (Output File Strategy "members") (Option Group "2") 1`] = `
-"# ClassWithFlags
+"# Class: ClassWithFlags
 
 Comment for ClassWithFlags
 
@@ -822,7 +822,7 @@ Comment for staticMethod
 `;
 
 exports[`Class Reflection should compile class with modifiers: (Output File Strategy "members") (Option Group "2") 1`] = `
-"# \`abstract\` ClassWithModifiers
+"# Class: \`abstract\` ClassWithModifiers
 
 Comments for ClassWithModifiers
 
@@ -988,7 +988,7 @@ SomeTag
 `;
 
 exports[`Class Reflection should compile class with simple props: (Output File Strategy "members") (Option Group "2") 1`] = `
-"# ClassWithSimpleProps
+"# Class: ClassWithSimpleProps
 
 Comments for ClassWithSimpleProps
 
@@ -1045,7 +1045,7 @@ Comments for param B
 `;
 
 exports[`Class Reflection should compile class with type parameters: (Output File Strategy "members") (Option Group "2") 1`] = `
-"# ClassWithTypeParameters\\<A, B, C\\>
+"# Class: ClassWithTypeParameters\\<A, B, C\\>
 
 Comments for ClassWithTypeParameters
 
@@ -1157,7 +1157,7 @@ Comments for abstractMethod
 `;
 
 exports[`Class Reflection should compile derived class: (Output File Strategy "members") (Option Group "2") 1`] = `
-"# DerivedClassA
+"# Class: DerivedClassA
 
 Comments for DerivedClassA
 

packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.enum.spec.ts.snap

@@ -32,7 +32,7 @@ Comments for MemberB
 `;
 
 exports[`Enum Reflection should compile basic enum: (Output File Strategy "members") (Option Group "2") 1`] = `
-"# BasicEnum
+"# Enumeration: BasicEnum
 
 Comments for enum
 
@@ -73,7 +73,7 @@ Comments for enum
 `;
 
 exports[`Enum Reflection should compile enum with values: (Output File Strategy "members") (Option Group "2") 1`] = `
-"# EnumWithValues
+"# Enumeration: EnumWithValues
 
 Comments for enum