chore(core): updated json schema

typedoc2md · Jun 29, 2024 · 1ff81cd · 1ff81cd
1 parent cfe7c58
commit 1ff81cd
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 4 deletions.
diff --git a/docs/public/schema.json b/docs/public/schema.json
@@ -43,7 +43,7 @@
         "excludeGroups": {
           "type": "boolean",
           "deprecated": "This option has been renamed hideGroupHeadings to better reflect its purpose.",
-          "description": "[typedoc-plugin-markdown] undefined"
+          "description": "[typedoc-plugin-markdown] This option has been renamed hideGroupHeadings to better reflect its purpose."
         },
         "excludeScopesInPaths": {
           "type": "boolean",
@@ -86,7 +86,8 @@
           "type": "string",
           "enum": [
             "list",
-            "table"
+            "table",
+            "htmlTable"
           ],
           "description": "[typedoc-plugin-markdown] Sets the format of index items.",
           "default": "list"

diff --git a/packages/typedoc-plugin-markdown/.scripts/schema/generate-schema.ts b/packages/typedoc-plugin-markdown/.scripts/schema/generate-schema.ts
@@ -11,7 +11,7 @@ async function main() {
   for (const key in schema.properties) {
     const property = schema.properties[key];
     if (typeof property === 'object' && property !== null) {
-      property.description = `[typedoc-plugin-markdown] ${property.description}`;
+      property.description = `[typedoc-plugin-markdown] ${property.description || (property as any)?.deprecated}`;
       property.default =
         declarations[key].defaultValue || declarations[key].defaults;
       if (property.required) {

diff --git a/packages/typedoc-plugin-markdown/supporting-docs/public/customizing-output.md b/packages/typedoc-plugin-markdown/supporting-docs/public/customizing-output.md
@@ -48,7 +48,7 @@ You would typically use this event to modify urls or navigation structure.
  */
 export function load(app) {
   app.renderer.on(MarkdownRendererEvent.BEGIN, (renderer) => {
-    renderer.urls = event.urls.map((urlMapping) => {
+    renderer.urls = renderer.urls?.map((urlMapping) => {
       const newUrl = urlMapping.url.replace('foo', 'bar');
       urlMapping.url = newUrl;
       urlMapping.model.url = newUrl; // also required