feat(core): typedoc 0.28 compatibility fixes and enhancements

Author: tgreyuk

.changeset/clear-eagles-taste.md

@@ -0,0 +1,8 @@
+---
+'typedoc-plugin-markdown': minor
+---
+
+- Implemented custom routers for plugin to support TypeDoc 0.28 router implementation.
+- Updated HTML anchors in headings and table rows to be unique, to avoid clashing with any auto generated ids.
+- Added "typeAliasPropertiesFormat" option to support TypeDoc 0.28 updated behaviour for Object literal type alias types.
+- The page header (if displayed) will contain separate links to Readme and index page (if applicable).

.changeset/config.json

@@ -13,6 +13,10 @@
   "ignore": [
     "@devtools/*",
     "typedoc-github-wiki-theme",
-    "typedoc-gitlab-wiki-theme"
+    "typedoc-gitlab-wiki-theme",
+    "typedoc-vitepress-theme",
+    "typedoc-plugin-frontmatter",
+    "docusaurus-plugin-typedoc",
+    "typedoc-plugin-remark"
   ]
 }

.github/workflows/ci.docusaurus-plugin-typedoc.yml

@@ -6,6 +6,10 @@ on:
       - '!packages/docusaurus-plugin-typedoc/README.md'
       - '!packages/docusaurus-plugin-typedoc/CHANGELOG.md'
       - '!packages/docusaurus-plugin-typedoc/package.json'
+    branches:
+      - main
+      - release
+      - beta
   pull_request:
     paths:
       - 'packages/docusaurus-plugin-typedoc/**'

.github/workflows/ci.typedoc-github-wiki-theme.yml

@@ -6,6 +6,10 @@ on:
       - '!packages/typedoc-github-wiki-theme/README.md'
       - '!packages/typedoc-github-wiki-theme/CHANGELOG.md'
       - '!packages/typedoc-github-wiki-theme/package.json'
+    branches:
+      - main
+      - release
+      - beta
   pull_request:
     paths:
       - 'packages/typedoc-github-wiki-theme/**'

.github/workflows/ci.typedoc-gitlab-wiki-theme.yml

@@ -6,6 +6,10 @@ on:
       - '!packages/typedoc-gitlab-wiki-theme/README.md'
       - '!packages/typedoc-gitlab-wiki-theme/CHANGELOG.md'
       - '!packages/typedoc-gitlab-wiki-theme/package.json'
+    branches:
+      - main
+      - release
+      - beta
   pull_request:
     paths:
       - 'packages/typedoc-gitlab-wiki-theme/**'

.github/workflows/ci.typedoc-plugin-frontmatter.yml

@@ -6,6 +6,10 @@ on:
       - '!packages/typedoc-plugin-frontmatter/README.md'
       - '!packages/typedoc-plugin-frontmatter/CHANGELOG.md'
       - '!packages/typedoc-plugin-frontmatter/package.json'
+    branches:
+      - main
+      - release
+      - beta
   pull_request:
     paths:
       - 'packages/typedoc-plugin-frontmatter/**'

.github/workflows/ci.typedoc-plugin-remark.yml

@@ -6,6 +6,10 @@ on:
       - '!packages/typedoc-plugin-remark/README.md'
       - '!packages/typedoc-plugin-remark/CHANGELOG.md'
       - '!packages/typedoc-plugin-remark/package.json'
+    branches:
+      - main
+      - release
+      - beta
   pull_request:
     paths:
       - 'packages/typedoc-plugin-remark/**'

.github/workflows/ci.typedoc-vitepress-theme.yml

@@ -6,6 +6,10 @@ on:
       - '!packages/typedoc-vitepress-theme/README.md'
       - '!packages/typedoc-vitepress-theme/CHANGELOG.md'
       - '!packages/typedoc-vitepress-theme/package.json'
+    branches:
+      - main
+      - release
+      - beta
   pull_request:
     paths:
       - 'packages/typedoc-vitepress-theme/**'

.github/workflows/ci.yml

@@ -10,6 +10,7 @@ on:
     branches:
       - main
       - release
+      - beta
   pull_request:
     paths:
       - 'packages/typedoc-plugin-markdown/**'

.gitignore

@@ -4,6 +4,10 @@
 dist
 .nyc_output/
 
+# yalc
+yalc.lock
+.yalc
+
 # testing
 samples
 typedoc-examples
@@ -15,27 +19,13 @@ html
 node_modules
 
 # IDEs and editors
-/.idea
-.project
-.classpath
-.c9/
-*.launch
 .settings/
 
 # misc
-/.sass-cache
-/connect.lock
-coverage
-/libpeerconnection.log
 npm-debug.log
-testem.log
 /typings
 .npmrc
 
-# e2e
-/e2e/*.js
-/e2e/*.map
-
 #System Files
 .DS_Store
 Thumbs.db