typedoc 0.24.0 → 0.24.1
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.
|
@@ -174,7 +174,7 @@ function exampleBlockContent(comment, lexer, config, warning) {
|
|
|
174
174
|
const content = blockContent(comment, lexer, config, () => { });
|
|
175
175
|
const end = lexer.done() || lexer.peek();
|
|
176
176
|
lexer.release();
|
|
177
|
-
if (content.some((part) => part.kind === "code")) {
|
|
177
|
+
if (content.some((part) => part.kind === "code" && part.text.startsWith("```"))) {
|
|
178
178
|
return blockContent(comment, lexer, config, warning);
|
|
179
179
|
}
|
|
180
180
|
const tokens = [];
|
|
@@ -59,6 +59,7 @@ export interface TypeDocOptionMap {
|
|
|
59
59
|
options: string;
|
|
60
60
|
tsconfig: string;
|
|
61
61
|
compilerOptions: unknown;
|
|
62
|
+
plugin: string[];
|
|
62
63
|
entryPoints: string[];
|
|
63
64
|
entryPointStrategy: typeof EntryPointStrategy;
|
|
64
65
|
exclude: string[];
|
|
@@ -70,9 +71,13 @@ export interface TypeDocOptionMap {
|
|
|
70
71
|
excludePrivate: boolean;
|
|
71
72
|
excludeProtected: boolean;
|
|
72
73
|
excludeReferences: boolean;
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
74
|
+
name: string;
|
|
75
|
+
includeVersion: boolean;
|
|
76
|
+
disableSources: boolean;
|
|
77
|
+
sourceLinkTemplate: string;
|
|
78
|
+
gitRevision: string;
|
|
79
|
+
gitRemote: string;
|
|
80
|
+
readme: string;
|
|
76
81
|
out: string;
|
|
77
82
|
json: string;
|
|
78
83
|
pretty: boolean;
|
|
@@ -82,59 +87,54 @@ export interface TypeDocOptionMap {
|
|
|
82
87
|
darkHighlightTheme: ShikiTheme;
|
|
83
88
|
customCss: string;
|
|
84
89
|
markedOptions: unknown;
|
|
85
|
-
name: string;
|
|
86
|
-
includeVersion: boolean;
|
|
87
|
-
disableSources: boolean;
|
|
88
90
|
basePath: string;
|
|
89
|
-
excludeTags: `@${string}`[];
|
|
90
|
-
readme: string;
|
|
91
91
|
cname: string;
|
|
92
|
-
sourceLinkTemplate: string;
|
|
93
|
-
gitRevision: string;
|
|
94
|
-
gitRemote: string;
|
|
95
92
|
htmlLang: string;
|
|
96
93
|
githubPages: boolean;
|
|
94
|
+
cacheBust: boolean;
|
|
97
95
|
gaID: string;
|
|
98
96
|
hideGenerator: boolean;
|
|
99
|
-
cacheBust: boolean;
|
|
100
97
|
searchInComments: boolean;
|
|
101
98
|
cleanOutputDir: boolean;
|
|
102
99
|
titleLink: string;
|
|
103
100
|
navigationLinks: ManuallyValidatedOption<Record<string, string>>;
|
|
104
101
|
sidebarLinks: ManuallyValidatedOption<Record<string, string>>;
|
|
105
|
-
|
|
102
|
+
visibilityFilters: ManuallyValidatedOption<{
|
|
103
|
+
protected?: boolean;
|
|
104
|
+
private?: boolean;
|
|
105
|
+
inherited?: boolean;
|
|
106
|
+
external?: boolean;
|
|
107
|
+
[tag: `@${string}`]: boolean;
|
|
108
|
+
}>;
|
|
109
|
+
searchCategoryBoosts: ManuallyValidatedOption<Record<string, number>>;
|
|
110
|
+
searchGroupBoosts: ManuallyValidatedOption<Record<string, number>>;
|
|
106
111
|
commentStyle: typeof CommentStyle;
|
|
107
112
|
useTsLinkResolution: boolean;
|
|
113
|
+
jsDocCompatibility: JsDocCompatibility;
|
|
108
114
|
blockTags: `@${string}`[];
|
|
109
115
|
inlineTags: `@${string}`[];
|
|
110
116
|
modifierTags: `@${string}`[];
|
|
117
|
+
excludeTags: `@${string}`[];
|
|
118
|
+
externalSymbolLinkMappings: ManuallyValidatedOption<Record<string, Record<string, string>>>;
|
|
119
|
+
media: string;
|
|
120
|
+
includes: string;
|
|
111
121
|
categorizeByGroup: boolean;
|
|
112
122
|
defaultCategory: string;
|
|
113
123
|
categoryOrder: string[];
|
|
114
124
|
sort: SortStrategy[];
|
|
115
125
|
kindSortOrder: ReflectionKind.KindString[];
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
[tag: `@${string}`]: boolean;
|
|
122
|
-
}>;
|
|
123
|
-
searchCategoryBoosts: ManuallyValidatedOption<Record<string, number>>;
|
|
124
|
-
searchGroupBoosts: ManuallyValidatedOption<Record<string, number>>;
|
|
126
|
+
treatWarningsAsErrors: boolean;
|
|
127
|
+
treatValidationWarningsAsErrors: boolean;
|
|
128
|
+
intentionallyNotExported: string[];
|
|
129
|
+
validation: ValidationOptions;
|
|
130
|
+
requiredToBeDocumented: ReflectionKind.KindString[];
|
|
125
131
|
watch: boolean;
|
|
126
132
|
preserveWatchOutput: boolean;
|
|
127
|
-
skipErrorChecking: boolean;
|
|
128
133
|
help: boolean;
|
|
129
134
|
version: boolean;
|
|
130
135
|
showConfig: boolean;
|
|
131
|
-
plugin: string[];
|
|
132
136
|
logLevel: typeof LogLevel;
|
|
133
|
-
|
|
134
|
-
treatValidationWarningsAsErrors: boolean;
|
|
135
|
-
intentionallyNotExported: string[];
|
|
136
|
-
validation: ValidationOptions;
|
|
137
|
-
requiredToBeDocumented: ReflectionKind.KindString[];
|
|
137
|
+
skipErrorChecking: boolean;
|
|
138
138
|
}
|
|
139
139
|
/**
|
|
140
140
|
* Wrapper type for values in TypeDocOptionMap which are represented with an unknown option type, but
|
package/package.json
CHANGED