Skip to content

Commit 1ff81cd

Browse files
committed
chore(core): updated json schema
1 parent cfe7c58 commit 1ff81cd

File tree

3 files changed

+5
-4
lines changed

3 files changed

+5
-4
lines changed

docs/public/schema.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
"excludeGroups": {
4444
"type": "boolean",
4545
"deprecated": "This option has been renamed hideGroupHeadings to better reflect its purpose.",
46-
"description": "[typedoc-plugin-markdown] undefined"
46+
"description": "[typedoc-plugin-markdown] This option has been renamed hideGroupHeadings to better reflect its purpose."
4747
},
4848
"excludeScopesInPaths": {
4949
"type": "boolean",
@@ -86,7 +86,8 @@
8686
"type": "string",
8787
"enum": [
8888
"list",
89-
"table"
89+
"table",
90+
"htmlTable"
9091
],
9192
"description": "[typedoc-plugin-markdown] Sets the format of index items.",
9293
"default": "list"

packages/typedoc-plugin-markdown/.scripts/schema/generate-schema.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ async function main() {
1111
for (const key in schema.properties) {
1212
const property = schema.properties[key];
1313
if (typeof property === 'object' && property !== null) {
14-
property.description = `[typedoc-plugin-markdown] ${property.description}`;
14+
property.description = `[typedoc-plugin-markdown] ${property.description || (property as any)?.deprecated}`;
1515
property.default =
1616
declarations[key].defaultValue || declarations[key].defaults;
1717
if (property.required) {

packages/typedoc-plugin-markdown/supporting-docs/public/customizing-output.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ You would typically use this event to modify urls or navigation structure.
4848
*/
4949
export function load(app) {
5050
app.renderer.on(MarkdownRendererEvent.BEGIN, (renderer) => {
51-
renderer.urls = event.urls.map((urlMapping) => {
51+
renderer.urls = renderer.urls?.map((urlMapping) => {
5252
const newUrl = urlMapping.url.replace('foo', 'bar');
5353
urlMapping.url = newUrl;
5454
urlMapping.model.url = newUrl; // also required

0 commit comments

Comments
 (0)