Merge branch 'beta' into custom-footer-string

Also add customFooterHtmlDisableWrapper option

.config/.prettierignore

@@ -12,6 +12,3 @@
 ../example/docs/
 **/tmp
 **/.vs
-
-# Remove once Prettier has support
-../src/test/converter2/behavior/resolutionMode.ts

.config/typedoc.json

@@ -13,6 +13,7 @@
     ],
     "sort": ["kind", "instance-first", "required-first", "alphabetical"],
     "entryPoints": ["../src/index.ts"],
+    "projectDocuments": ["../CHANGELOG.md"],
     "excludeExternals": true,
     "excludeInternal": false,
     "excludePrivate": true,
@@ -44,5 +45,10 @@
         "includeGroups": false
     },
     "includeVersion": true,
-    "logLevel": "Verbose"
+    "logLevel": "Verbose",
+    "externalSymbolLinkMappings": {
+        "@types/markdown-it": {
+            "MarkdownIt": "https://markdown-it.github.io/markdown-it/#MarkdownIt"
+        }
+    }
 }

.eslintrc

@@ -38,6 +38,14 @@
     "rules": {
         "@typescript-eslint/no-floating-promises": "error",
         "@typescript-eslint/await-thenable": "error",
+        "@typescript-eslint/consistent-type-imports": [
+            "error",
+            {
+                "fixStyle": "inline-type-imports",
+                "prefer": "type-imports",
+                "disallowTypeAnnotations": false
+            }
+        ],
 
         // This one is just annoying since it complains at incomplete code
         "no-empty": "off",

.github/ISSUE_TEMPLATE/bug_report.md

@@ -22,8 +22,9 @@ labels: bug
 Note: Turn off skipErrorChecks before reporting a crash. Bug reports for crashes with that option
 on are out of scope.
 
-If possible, please create a *minimal* repo reproducing your problem and link it.
-You can easily do this by submitting a pull request to https://github.com/TypeStrong/typedoc-repros
+If possible, please create a *minimal* repo reproducing your problem.
+If it is more than a single small file, please submit a pull request to
+https://github.com/TypeStrong/typedoc-repros
 which changes the files necessary to reproduce your bug.
 
 If this is not possible, include at least:

.github/workflows/ci.yml

@@ -5,13 +5,13 @@ jobs:
         runs-on: ubuntu-latest
         strategy:
             matrix:
-                node: ["18", "20", "21"]
+                node: ["18", "20", "22"]
         name: Node ${{ matrix.node }}
         steps:
             - name: Checkout repository
-              uses: actions/checkout@v3
+              uses: actions/checkout@v4
             - name: Set up Node
-              uses: actions/setup-node@v3
+              uses: actions/setup-node@v4
               with:
                   node-version: ${{ matrix.node }}
             - name: Install
@@ -27,17 +27,17 @@ jobs:
             - name: Lint
               run: npm run lint -- --max-warnings 0
             - name: Circular dependency check
-              uses: gerrit0/circular-dependency-check@v2
+              uses: gerrit0/circular-dependency-check@v2.0.1
               with:
                   entry: dist/index.js
     build-windows:
         runs-on: windows-latest
         name: Node 18 Windows
         steps:
             - name: Checkout repository
-              uses: actions/checkout@v3
+              uses: actions/checkout@v4
             - name: Set up Node
-              uses: actions/setup-node@v3
+              uses: actions/setup-node@v4
               with:
                   node-version: 18
             - name: Upgrade npm

.github/workflows/publish-beta.yml

@@ -9,16 +9,16 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - name: Checkout repository
-              uses: actions/checkout@v3
+              uses: actions/checkout@v4
             - id: check
-              uses: EndBug/version-check@v1
+              uses: EndBug/version-check@v2.1.4
               with:
                   diff-search: true
             - name: Set up Node
               if: steps.check.outputs.changed == 'true' && contains(steps.check.outputs.version, 'beta')
-              uses: actions/setup-node@v1
+              uses: actions/setup-node@v4
               with:
-                  node-version: "20"
+                  node-version: "18"
             - name: Upgrade npm
               if: steps.check.outputs.changed == 'true' && contains(steps.check.outputs.version, 'beta')
               run: npm i -g npm@latest

.github/workflows/publish-lts.yml

@@ -9,16 +9,16 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - name: Checkout repository
-              uses: actions/checkout@v3
+              uses: actions/checkout@v4
             - id: check
-              uses: EndBug/version-check@v1
+              uses: EndBug/version-check@v2.1.4
               with:
                   diff-search: true
             - name: Set up Node
               if: steps.check.outputs.changed == 'true'
-              uses: actions/setup-node@v3
+              uses: actions/setup-node@v4
               with:
-                  node-version: "20"
+                  node-version: "18"
             - name: Upgrade npm
               if: steps.check.outputs.changed == 'true'
               run: npm i -g npm@latest

.github/workflows/publish.yml

@@ -9,18 +9,18 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - name: Checkout repository
-              uses: actions/checkout@v3
+              uses: actions/checkout@v4
               with:
                   fetch-depth: 0
             - id: check
-              uses: EndBug/version-check@v2.1.0
+              uses: EndBug/version-check@v2.1.4
               with:
                   diff-search: true
             - name: Set up Node
               if: steps.check.outputs.changed == 'true'
-              uses: actions/setup-node@v3
+              uses: actions/setup-node@v4
               with:
-                  node-version: "20"
+                  node-version: "18"
             - name: Install
               if: steps.check.outputs.changed == 'true'
               run: npm ci

.github/workflows/visual-regression.yml

@@ -5,11 +5,11 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - name: Checkout repository
-              uses: actions/checkout@v3
+              uses: actions/checkout@v4
             - name: Set up Node
-              uses: actions/setup-node@v3
+              uses: actions/setup-node@v4
               with:
-                  node-version: 20
+                  node-version: 18
             - name: Upgrade npm
               run: npm i -g npm@latest
             - name: Get baseline screenshots

.npmrc

@@ -3,3 +3,6 @@
 # an install, so just turn it off. We can still check for findings
 # with npm audit --production.
 audit = false
+
+# While we're on the TS beta, need this flag.
+legacy-peer-deps = true

.vscode/settings.json

@@ -41,6 +41,7 @@
     "mochaExplorer.configFile": ".config/mocha.test-explorer.json",
     "cSpell.words": [
         "cname",
+        "Combinatorially",
         "deserializers",
         "githubprivate",
         "linkcode",

CHANGELOG.md

@@ -1,16 +1,66 @@
-# Unreleased
+# Beta (full release: 2024-06-21)
 
-### Bug Fixes
+### To Do
 
+-   Handle `@document` tag to add documents to the tree for classes, interfaces, enums, functions, variables
+-   Handle image and relative markdown links within documents
+-   Update website docs - consider if reworking website to just be a TypeDoc generated site is a good idea
+    `@license`, `@import`, sitemapBaseUrl, markedOptions -> markdownItOptions, markdownItLoader, navigation
+    sort - documents-first, documents-last, alphabetical-ignoring-documents
+    searchInDocuments
+
+### Breaking Changes
+
+-   Drop support for Node 16.
+-   Moved from `marked` to `markdown-it` for parsing as marked has moved to an async model which supporting would significantly complicate TypeDoc's rendering code.
+    This means that any projects setting `markedOptions` needs to be updated to use `markdownItOptions`.
+    Unlike `marked@4`, `markdown-it` pushes lots of functionality to plugins. To use plugins, a JavaScript config file must be used with the `markdownItLoader` option.
+-   Updated Shiki from 0.14 to 1.x. This should mostly be a transparent update which adds another 23 supported languages and 13 supported themes.
+-   Renamed `--sitemapBaseUrl` to `--hostedBaseUrl` to reflect that it can be used for more than just the sitemap.
+-   Removed deprecated `navigation.fullTree` option.
+-   (WIP) Removed `--media` option, TypeDoc will now detect image links within your comments and markdown documents and automatically copy them to the site.
+-   Removed `--includes` option, use the `@document` tag instead.
+-   Removed `--stripYamlFrontmatter` option, TypeDoc will always do this now.
+-   All function-likes may now have comments directly attached to them. This is a change from previous versions of TypeDoc where functions comments
+    were always moved down to the signature level. This mostly worked, but caused problems with type aliases, so was partially changed in 0.25.13.
+    This change was extended to apply not only to type aliases, but also other function-likes declared with variables and callable properties.
+    As a part of this change, comments on the implementation signature of overloaded functions will now be added to the function reflection, and will
+    not be inherited by signatures of that function, #2521.
+-   API: `MapOptionDeclaration.mapError` has been removed.
+-   API: Deprecated `BindOption` decorator has been removed.
+-   API: `DeclarationReflection.indexSignature` has been renamed to `DeclarationReflection.indexSignatures`.
+    Note: This also affects JSON serialization. TypeDoc will support JSON output from 0.25 until at least 0.27.
+-   API: `DefaultThemeRenderContext.iconsCache` has been removed as it is no longer needed.
+
+### Features
+
+-   Added support for TypeScript 5.5.
+-   Added new `--projectDocuments` option to specify additional Markdown documents to be included in the generated site #247, #1870, #2288, #2565.
+-   TypeDoc now has the architecture in place to support localization. No languages besides English
+    are currently shipped in the package, but it is now possible to add support for additional languages, #2475.
+-   `--hostedBaseUrl` will now be used to generate a `<link rel="canonical">` element in the project root page, #2550.
+-   Added three new sort strategies `documents-first`, `documents-last`, and `alphabetical-ignoring-documents` to order markdown documents.
+-   Added new `--alwaysCreateEntryPointModule` option. When set, TypeDoc will always create a `Module` for entry points, even if only one is provided.
+    If `--projectDocuments` is used to add documents, this option defaults to `true`, otherwise, defaults to `false`.
+
+### Bug Fixes
+
+-   TypeDoc now supports objects with multiple index signatures, #2470.
 -   Header anchor links in rendered markdown are now more consistent with headers generated by TypeDoc, #2546.
 -   Types rendered in the `Returns` header are now properly colored, #2546.
 -   Links added with the `navigationLinks` option are now moved into the pull out navigation on mobile displays, #2548.
 -   `@license` and `@import` comments will be ignored at the top of files, #2552.
 -   Fixed issue in documentation validation where constructor signatures where improperly considered not documented, #2553.
+-   Fixed issue where search results could not be navigated while Windows Narrator was on, #2563.
+-   `charset` is now correctly cased in `<meta>` tag generated by the default theme, #2568.
+-   `--hostedBaseUrl` will now implicitly add a trailing slash to the generated URL.
 
 ### Thanks!
 
 -   @HarelM
+-   @kraenhansen
+
+# Unreleased
 
 ## v0.25.13 (2024-04-07)
 

example/README.md

@@ -23,7 +23,7 @@ This project shows off some of TypeDoc's features:
 
 -   Built-in support for various TypeScript language constructs
 -   Markdown in doc comments
--   Syntax highligting in code blocks
+-   Syntax highlighting in code blocks
 
 ## Index of Examples