typedoc-plugin-markdown - npm Package Compare versions

Comparing version 3.16.0 to 3.17.0

dist/resources/helpers/declaration-title.js

@@ -46,3 +46,3 @@ "use strict";
         if (this instanceof typedoc_1.DeclarationReflection && this.typeParameters) {
-            md.push(`<${this.typeParameters
+            md.push(`\\<${this.typeParameters
                 .map((typeParameter) => `\`${typeParameter.name}\``)
@@ -49,0 +49,0 @@ .join(', ')}\\>`);

dist/resources/helpers/reflection-title.js

@@ -45,3 +45,3 @@ "use strict";
                     .join(', ');
-                title.push(`<${typeParameters}${shouldEscape ? '\\>' : '>'}`);
+                title.push(`${shouldEscape ? '\\<' : '<'}${typeParameters}${shouldEscape ? '\\>' : '>'}`);
             }
@@ -48,0 +48,0 @@ }

dist/resources/helpers/signature-title.js

@@ -46,3 +46,3 @@ "use strict";
         if (this.typeParameters) {
-            md.push(`<${this.typeParameters
+            md.push(`\\<${this.typeParameters
                 .map((typeParameter) => `\`${typeParameter.name}\``)
@@ -49,0 +49,0 @@ .join(', ')}\\>`);

dist/resources/helpers/type.js

@@ -116,3 +116,3 @@ "use strict";
             });
-        return `{ ${indexSignature ? indexSignature : ''}${types ? types.join('; ') : ''} }${model.defaultValue && model.defaultValue !== '...'
+        return `\\{ ${indexSignature ? indexSignature : ''}${types ? types.join('; ') : ''} }${model.defaultValue && model.defaultValue !== '...'
             ? `= ${(0, utils_1.escapeChars)(model.defaultValue)}`
@@ -126,3 +126,3 @@ : ''}`;
         const typeParams = fn.typeParameters
-            ? `<${fn.typeParameters
+            ? `\\<${fn.typeParameters
                 .map((typeParameter) => typeParameter.name)
@@ -155,3 +155,3 @@ .join(', ')}\\>`
         if (model.typeArguments && model.typeArguments.length > 0) {
-            reflection.push(`<${model.typeArguments
+            reflection.push(`\\<${model.typeArguments
                 .map((typeArgument) => Handlebars.helpers.type.call(typeArgument))
@@ -158,0 +158,0 @@ .join(', ')}\\>`);

dist/utils.js

@@ -14,6 +14,8 @@ "use strict";
     return str
+        .replace(/</g, '\\<')
         .replace(/>/g, '\\>')
         .replace(/_/g, '\\_')
         .replace(/`/g, '\\`')
-        .replace(/\|/g, '\\|');
+        .replace(/\|/g, '\\|')
+        .replace(/{/g, '\\{');
 }
@@ -20,0 +22,0 @@ exports.escapeChars = escapeChars;

package.json

 {
   "name": "typedoc-plugin-markdown",
-  "version": "3.16.0",
+  "version": "3.17.0",
   "description": "A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.",
@@ -11,4 +11,7 @@ "main": "dist/index.js",
     "lint": "eslint ./src --ext .ts",
-    "markdownlint": "yarn run docs:md && markdownlint ./docs/md",
-    "prepublishOnly": "yarn run lint && yarn run build",
+    "prelint:docs": "yarn run docs:md",
+    "lint:md": "yarn run lint:markdown && yarn run lint:mdx",
+    "lint:markdown": " markdownlint ./docs/md",
+    "lint:mdx": "node ./lint.mdx.mjs",
+    "prepublishOnly": "yarn run lint && yarn run build && yarn run test",
     "build": "rm -rf dist && tsc && copyfiles --up 1 ./src/**/*.hbs ./dist/",
@@ -15,0 +18,0 @@ "test": "jest",

No alert changes

Improved metrics

Total package byte prevSize

115310

increased by0.21%

Lines of code

2481

increased by0.08%

No dependency changes