typedoc 0.26.2 → 0.26.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -73,7 +73,7 @@ export interface TypeDocOptionMap {
73
73
  externalPattern: string[];
74
74
  excludeExternals: boolean;
75
75
  excludeNotDocumented: boolean;
76
- excludeNotDocumentedKinds: Array<keyof typeof ReflectionKind>;
76
+ excludeNotDocumentedKinds: ReflectionKind.KindString[];
77
77
  excludeInternal: boolean;
78
78
  excludePrivate: boolean;
79
79
  excludeProtected: boolean;
@@ -1,5 +1,5 @@
1
1
  export declare const tsdocBlockTags: readonly ["@defaultValue", "@deprecated", "@example", "@param", "@privateRemarks", "@remarks", "@returns", "@see", "@throws", "@typeParam"];
2
- export declare const blockTags: readonly ["@defaultValue", "@deprecated", "@example", "@param", "@privateRemarks", "@remarks", "@returns", "@see", "@throws", "@typeParam", "@author", "@callback", "@category", "@categoryDescription", "@default", "@document", "@group", "@groupDescription", "@import", "@inheritDoc", "@jsx", "@license", "@module", "@prop", "@property", "@return", "@satisfies", "@template", "@type", "@typedef"];
2
+ export declare const blockTags: readonly ["@defaultValue", "@deprecated", "@example", "@param", "@privateRemarks", "@remarks", "@returns", "@see", "@throws", "@typeParam", "@author", "@callback", "@category", "@categoryDescription", "@default", "@document", "@group", "@groupDescription", "@import", "@inheritDoc", "@jsx", "@license", "@module", "@prop", "@property", "@return", "@satisfies", "@since", "@template", "@type", "@typedef"];
3
3
  export declare const tsdocInlineTags: readonly ["@link", "@inheritDoc", "@label"];
4
4
  export declare const inlineTags: readonly ["@link", "@inheritDoc", "@label", "@linkcode", "@linkplain"];
5
5
  export declare const tsdocModifierTags: readonly ["@alpha", "@beta", "@eventProperty", "@experimental", "@internal", "@override", "@packageDocumentation", "@public", "@readonly", "@sealed", "@virtual"];
@@ -33,8 +33,9 @@ exports.blockTags = [
33
33
  "@property",
34
34
  "@return",
35
35
  "@satisfies",
36
+ "@since",
36
37
  "@template", // Alias for @typeParam
37
- "@type", // Because TypeScript is important!
38
+ "@type",
38
39
  "@typedef",
39
40
  ];
40
41
  exports.tsdocInlineTags = ["@link", "@inheritDoc", "@label"];
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "typedoc",
3
3
  "description": "Create api documentation for TypeScript projects.",
4
- "version": "0.26.2",
4
+ "version": "0.26.3",
5
5
  "homepage": "https://typedoc.org",
6
6
  "exports": {
7
7
  ".": "./dist/index.js",
@@ -26,8 +26,8 @@
26
26
  "dependencies": {
27
27
  "lunr": "^2.3.9",
28
28
  "markdown-it": "^14.1.0",
29
- "minimatch": "^9.0.4",
30
- "shiki": "^1.9.0",
29
+ "minimatch": "^9.0.5",
30
+ "shiki": "^1.9.1",
31
31
  "yaml": "^2.4.5"
32
32
  },
33
33
  "peerDependencies": {
@@ -36,18 +36,18 @@
36
36
  "devDependencies": {
37
37
  "@types/lunr": "^2.3.7",
38
38
  "@types/markdown-it": "^14.1.1",
39
- "@types/mocha": "^10.0.6",
39
+ "@types/mocha": "^10.0.7",
40
40
  "@types/node": "18",
41
41
  "@typestrong/fs-fixture-builder": "github:TypeStrong/fs-fixture-builder#34113409e3a171e68ce5e2b55461ef5c35591cfe",
42
42
  "c8": "^10.1.2",
43
43
  "esbuild": "^0.21.5",
44
44
  "eslint": "^9.5.0",
45
- "mocha": "^10.4.0",
45
+ "mocha": "^10.5.2",
46
46
  "prettier": "3.3.2",
47
- "puppeteer": "^22.12.0",
47
+ "puppeteer": "^22.12.1",
48
48
  "ts-node": "^10.9.2",
49
49
  "typescript": "5.5.2",
50
- "typescript-eslint": "^7.13.1"
50
+ "typescript-eslint": "^7.14.1"
51
51
  },
52
52
  "files": [
53
53
  "/bin",
package/static/style.css CHANGED
@@ -793,6 +793,15 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark {
793
793
  margin-left: -1.5rem;
794
794
  }
795
795
 
796
+ .tsd-page-navigation-section {
797
+ margin-left: 10px;
798
+ }
799
+ .tsd-page-navigation-section > summary {
800
+ padding: 0.25rem;
801
+ }
802
+ .tsd-page-navigation-section > div {
803
+ margin-left: 20px;
804
+ }
796
805
  .tsd-page-navigation ul {
797
806
  padding-left: 1.75rem;
798
807
  }
@@ -841,6 +850,7 @@ a.tsd-index-link {
841
850
  }
842
851
  .tsd-accordion .tsd-accordion-summary > svg {
843
852
  margin-left: 0.25rem;
853
+ vertical-align: text-top;
844
854
  }
845
855
  .tsd-index-content > :not(:first-child) {
846
856
  margin-top: 0.75rem;
package/tsdoc.json CHANGED
@@ -115,6 +115,10 @@
115
115
  "tagName": "@satisfies",
116
116
  "syntaxKind": "block"
117
117
  },
118
+ {
119
+ "tagName": "@since",
120
+ "syntaxKind": "block"
121
+ },
118
122
  {
119
123
  "tagName": "@license",
120
124
  "syntaxKind": "block"
@@ -1,4 +0,0 @@
1
- import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
2
- import { JSX } from "../../../../utils";
3
- import type { ReflectionGroup } from "../../../../models";
4
- export declare function membersGroup(context: DefaultThemeRenderContext, group: ReflectionGroup): JSX.Element;
@@ -1,25 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.membersGroup = membersGroup;
4
- const utils_1 = require("../../../../utils");
5
- function membersGroup(context, group) {
6
- if (group.categories) {
7
- return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null, group.categories.map((item) => {
8
- const title = `${group.title} - ${item.title}`;
9
- return (utils_1.JSX.createElement("details", { class: "tsd-panel-group tsd-member-group tsd-accordion", open: true },
10
- utils_1.JSX.createElement("summary", { class: "tsd-accordion-summary", "data-key": "section-" + title },
11
- utils_1.JSX.createElement("h2", null,
12
- context.icons.chevronDown(),
13
- " ",
14
- title)),
15
- utils_1.JSX.createElement("section", null, item.children.map((item) => !item.hasOwnDocument && context.member(item)))));
16
- })));
17
- }
18
- return (utils_1.JSX.createElement("details", { class: "tsd-panel-group tsd-member-group tsd-accordion", open: true },
19
- utils_1.JSX.createElement("summary", { class: "tsd-accordion-summary", "data-key": "section-" + group.title },
20
- utils_1.JSX.createElement("h2", null,
21
- context.icons.chevronDown(),
22
- " ",
23
- group.title)),
24
- utils_1.JSX.createElement("section", null, group.children.map((item) => !item.hasOwnDocument && context.member(item)))));
25
- }