feat(core): core router support and further theme alignment to core theme

Author: tgreyuk

.changeset/config.json

@@ -12,6 +12,8 @@
   "updateInternalDependencies": "minor",
   "ignore": [
     "@devtools/*",
+    "typedoc-plugin-frontmatter",
+    "typedoc-plugin-remark",
     "typedoc-github-wiki-theme",
     "typedoc-gitlab-wiki-theme",
     "typedoc-vitepress-theme",

.changeset/dirty-actors-poke.md

@@ -0,0 +1,6 @@
+---
+'typedoc-plugin-markdown': patch
+---
+
+- Fix incompatibility when used with "outputs" (#788).
+- Utilize "anchorPrefix" option to ensure unique anchors linking if required (#764).

.changeset/icy-dryers-smile.md

@@ -0,0 +1,8 @@
+---
+'typedoc-plugin-markdown': minor
+---
+
+- Implemented support for consuming TypeDoc core routers.
+- Exported routers to public api.
+- Implemented a hierarchy summary page as per default theme.
+- Updated "Constructor" titles of classes to fix internal anchor issues.

devtools/examples/docusaurus/docusaurus.config.js

@@ -59,13 +59,8 @@ const config = {
           '../../../packages/typedoc-plugin-markdown/test/fixtures/tsconfig.json',
         ),
         entryPoints: [
-          '../../../packages/typedoc-plugin-markdown/test/fixtures/src/groups/**/*.ts',
+          '../../../packages/typedoc-plugin-markdown/test/fixtures/src/reflections/index.ts',
         ],
-        expandObjects: true,
-        readme: 'none',
-        sidebar: { pretty: true },
-        outputFileStrategy: 'modules',
-        cleanOutputDir: true,
       },
     ],
     [
@@ -84,10 +79,9 @@ const config = {
           '../../../packages/typedoc-plugin-markdown/test/fixtures/tsconfig.json',
         ),
         entryPoints: [
-          '../../../packages/typedoc-plugin-markdown/test/fixtures/src/modules/module-1',
-          '../../../packages/typedoc-plugin-markdown/test/fixtures/src/modules/module-2',
+          '../../../packages/typedoc-plugin-markdown/test/fixtures/src//packages/*',
         ],
-        entryPointStrategy: 'expand',
+        entryPointStrategy: 'packages',
         cleanOutputDir: true,
         navigation: {
           includeFolders: false,

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

@@ -26,10 +26,12 @@ asIndexPage: true
 
   outputPage.push(`import { Callout } from 'nextra/components';`);
 
-  outputPage.push('# Options');
+  outputPage.push('# Plugin Options');
   if (docsConfig.docsPath === '/docs') {
     outputPage.push(
-      `<Callout type="info">These options should be used in conjunction with the core TypeDoc options (see [TypeDoc Usage](/docs/typedoc-usage)).</Callout>`,
+      `This page documents additional options that are exposed by this plugin.
+
+*Note: The options must be set at root level and will be ignored inside [packageOptions](https://typedoc.org/documents/Options.Package_Options.html).*`,
     );
   } else {
     if (docsConfig.presets) {

devtools/packages/testing/index.ts

@@ -12,7 +12,7 @@ export function expectFileToEqual(
     ? outputFileStrategy
     : [outputFileStrategy];
   outputFileStrategies.forEach((outputFileStrategy) => {
-    const basePath = getBasePath(key, outputFileStrategy);
+    const basePath = getOutputFileStrategyPath(key, outputFileStrategy);
 
     const optionDirs = fs.readdirSync(basePath);
     optionDirs.forEach((optionDir, index) => {
@@ -44,7 +44,7 @@ export function expectUrlsToEqual(
   outputFileStrategies: ('members' | 'modules')[],
 ) {
   outputFileStrategies.forEach((outputFileStrategy) => {
-    const basePath = getBasePath(outDir, outputFileStrategy);
+    const basePath = getOutputFileStrategyPath(outDir, outputFileStrategy);
     const optionDirs = fs.readdirSync(basePath);
     optionDirs.forEach((optionDir) => {
       const optionsBasePath = path.join(basePath, optionDir);
@@ -78,12 +78,51 @@ export function expectUrlsToEqual(
   });
 }
 
-function getBasePath(key: string, outputFileStrategy: 'modules' | 'members') {
+export function getOutDir() {
+  return path.join(process.cwd(), 'test', 'fixtures', 'out');
+}
+
+export function expectDirToEqual(outDir: string) {
+  const basePath = getPath(outDir);
+  const rootDirectory = fs.readdirSync(path.join(basePath));
+  const reduceDirectory = (
+    basePath: string,
+    baseDirectory: string,
+    directory: string[],
+  ) => {
+    return directory.reduce((prev: any, item) => {
+      if (fs.lstatSync(`${basePath}/${item}`).isDirectory()) {
+        const nestedDir = fs.readdirSync(`${basePath}/${item}`);
+        return [
+          ...prev,
+          ...reduceDirectory(
+            `${basePath}/${item}`,
+            `${baseDirectory}/${item}`,
+            nestedDir,
+          ),
+        ];
+      }
+      return [...prev, `${baseDirectory}/${item}`.replace(/^\/+/, '')];
+    }, []);
+  };
+  const urls = reduceDirectory(basePath, '', rootDirectory);
+  expect(urls).toMatchSnapshot(`dir: ${outDir}`);
+}
+
+function getPath(dir: string) {
+  return path.join(process.cwd(), 'test', 'fixtures', 'out', dir);
+}
+
+function getOutputFileStrategyPath(
+  key: string,
+  outputFileStrategy: 'modules' | 'members',
+) {
   const basePath = path.join(
     process.cwd(),
     'test',
     'fixtures',
     'out',
+    'md',
     key,
     outputFileStrategy,
   );

docs/content/docs/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 4.5.2
+
+### Patch Changes
+
+- Ensure all file paths use forward slashes in windows ([#782](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/782)).
+
+## 4.5.1 (2025-03-18)
+
+### Patch Changes
+
+- Correctly handle package index paths ([#782](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/782)).
+- Make all options optional in PluginOptions interface ([#781](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/781)).
+
 ## 4.5.0 (2025-03-16)
 
 This release introduces support for [TypeDoc 0.28](https://github.com/TypeStrong/typedoc/blob/v0.28.0/CHANGELOG.md#v0280-2025-03-15) that contains several under-the-hood breaking API changes.

docs/content/docs/_meta.js

@@ -5,15 +5,16 @@ export default {
     title: 'Getting Started',
   },
   'quick-start': '',
+  'typedoc-options': '',
   options: '',
   '-- Guides': {
     type: 'separator',
     title: 'Guides',
   },
-  'typedoc-usage': '',
   'output-file-structure': '',
   'customizing-output': '',
   'utilizing-navigation': '',
+  'option-typings': '',
   '-- Support': {
     type: 'separator',
     title: 'Support',

docs/content/docs/option-typings.mdx

@@ -0,0 +1,35 @@
+import { Callout, FileTree } from 'nextra/components';
+
+# Option Typings
+
+You can inform your IDE about the shape of the exported options the plugin provides.
+
+## JSON Files
+
+You can utilize the provided JSON schema at https://typedoc-plugin-markdown.org/schema.json. For simplicity of configuration, this schema consolidates all options from TypeDoc and the plugin.
+
+```json filename="typedoc.json"
+{
+  "$schema": "https://typedoc-plugin-markdown.org/schema.json",
+  "entryPoints": ["./src/index.ts", "./src/secondary-entry.ts"],
+  "out": "docs",
+  "plugin": ["typedoc-plugin-markdown", "some-other-plugin"],
+};
+```
+
+## JavaScript Files
+
+For JavaScript files, the `PluginOptions` interface can be imported to a `typedoc.config.js` file with a `@type` annotation.
+
+You can use intersection types to combine the TypeDoc options with the plugin options.
+
+```js filename="typedoc.config.cjs"
+// @ts-check
+
+/** @type {import('typedoc').TypeDocOptions & import('typedoc-plugin-markdown').PluginOptions} */
+module.exports = {
+  entryPoints: ['./src/index.ts', './src/secondary-entry.ts'],
+  out: 'doc',
+  plugin: ['typedoc-plugin-markdown', 'some-other-plugin'],
+};
+```

docs/content/docs/options/display-options.mdx

@@ -331,3 +331,51 @@ In addition you can control the alignment of the header text.
   }
 }
 ```
+
+## pageTitleTemplates
+
+<Callout emoji="💡">Change specific text placeholders in the template.</Callout>
+
+> Accepts a key/value object.
+
+Customizes the page titles for index, module, and member pages in the documentation.
+
+This option is provided as an object, with keys corresponding to the page types.
+
+Each value can be either:
+
+- A string supporting placeholders.
+- A function that receives input arguments.
+
+Available placeholders / arguments:
+
+- `{projectName}` – The project's name, resolved by TypeDoc.
+- `{version}` – The project version, resolved by TypeDoc (when `includeVersion` is `true`).
+- `{kind}` – The reflection kind of the item.
+- `{name}` – The name of the module or member.
+
+Available keys:
+
+- `index` – For the main documentation index page. Supports `projectName` and `version`.
+- `module` – For module and namespace pages. Supports `kind` and `name`.
+- `member` – For individual member pages. Supports `kind` and `name`.
+
+Examples showing usage of both string (JS config) and function (JS/JSON config) values:
+
+```js filename="typedoc.cjs"
+pageTitleTemplates: {
+  index: (args) => `${args.projectName}: ${args.version}`,
+  module: (args) => `${args.kind}: ${args.name}`,
+  member: (args) => `${args.kind}: ${args.name}`,
+}
+```
+
+```json filename="typedoc.json"
+{
+  "pageTitleTemplates": {
+    "index": "{projectName} {version}",
+    "member": "{kind}: {name}",
+    "module": "{name}"
+  }
+}
+```