typedoc-plugin-markdown - npm Package Compare versions

Comparing version 2.0.6 to 2.0.7

dist/plugin.js

@@ -59,3 +59,3 @@ "use strict";
         if (theme) {
-            if (media && (theme instanceof theme_docusaurus_1.DocusaurusTheme || theme instanceof theme_gitbook_1.GitbookTheme)) {
+            if (media && (theme instanceof theme_docusaurus_1.DocusaurusTheme || theme instanceof theme_gitbook_1.GitbookTheme || theme instanceof theme_vuepress_1.VuePressTheme)) {
                 MarkdownPlugin_1.application.logger.warn(`[typedoc-markdown-plugin] media option is currently not supported in ${platform} theme`);
@@ -67,5 +67,2 @@ options.setValue('media', null);
         }
-        else {
-            MarkdownPlugin_1.application.logger.write('Markdown theme not set');
-        }
     }
@@ -91,3 +88,2 @@ static getTheme(platform, renderer, themePath, options) {
         return contents
-            .replace(/^ +/gm, '')
             .replace(/[\r\n]{3,}/g, '\n\n')
@@ -94,0 +90,0 @@ .replace(/!spaces/g, '')

dist/theme/helpers/breadcrumbs.js

@@ -12,3 +12,7 @@ "use strict";
     }
-    const md = plugin_1.MarkdownPlugin.theme.hasGlobalsFile ? [`[Globals](${relative_url_1.relativeUrl(this.project.url)}) /`] : [];
+    const mode = plugin_1.MarkdownPlugin.settings.mode;
+    const hasGlobalsFile = plugin_1.MarkdownPlugin.theme.hasGlobalsFile;
+    const md = mode === undefined || mode === 1 || hasGlobalsFile
+        ? [`[Globals](${relative_url_1.relativeUrl(this.project.url)}) /`]
+        : [];
     return breadcrumb(this.model, md);
@@ -15,0 +19,0 @@ }

dist/theme/helpers/member-symbol.js

@@ -6,3 +6,3 @@ "use strict";
     const isStatic = this.flags.map(flag => flag).includes('Static');
-    const symbol = '●';
+    const symbol = '•';
     if (this.kind === typedoc_1.ReflectionKind.ConstructorSignature) {
@@ -18,6 +18,6 @@ return '\\+';
     if (this.kind === typedoc_1.ReflectionKind.ObjectLiteral) {
-        return '■';
+        return '▪';
     }
     if (this.kind === typedoc_1.ReflectionKind.Property && isStatic) {
-        return '■';
+        return '▪';
     }
@@ -24,0 +24,0 @@ return symbol;

dist/theme/helpers/metadata.js

@@ -33,3 +33,3 @@ "use strict";
     if (page.url === plugin_1.MarkdownPlugin.theme.indexName) {
-        return page.project.name;
+        return (page.project.packageInfo && page.project.packageInfo.label) || page.project.name.replace(/^@.+?\//, '');
     }
@@ -36,0 +36,0 @@ if (page.url === plugin_1.MarkdownPlugin.theme.globalsName) {

dist/theme/helpers/parameter-name-and-type.js

@@ -6,7 +6,7 @@ "use strict";
     const md = [];
-    md.push('■');
+    md.push('▪');
     if (this.flags && !this.flags.isRest) {
         md.push(this.flags.map(flag => `\`${flag}\` `));
     }
-    md.push(`\`${this.flags.isRest ? '...' : ''} ${this.name}\``);
+    md.push(`${this.flags.isRest ? '...' : ''} **${this.name}**`);
     if (this.type) {
@@ -13,0 +13,0 @@ md.push(`: *${type_1.type.call(this.type)}*`);

dist/theme/helpers/project-title.js

@@ -7,3 +7,2 @@ "use strict";
 const theme_vuepress_1 = require("../theme.vuepress");
-const heading_1 = require("./heading");
 const relative_url_1 = require("./relative-url");
@@ -14,3 +13,3 @@ function projectTitle() {
     }
-    return `> ${heading_1.heading(2)} [${this.project.name}](${relative_url_1.relativeUrl(plugin_1.MarkdownPlugin.theme.indexName)})`;
+    return `> **[${this.project.name}](${relative_url_1.relativeUrl(plugin_1.MarkdownPlugin.theme.indexName)})**`;
 }
@@ -17,0 +16,0 @@ exports.projectTitle = projectTitle;

dist/theme/helpers/signature-title.js

@@ -33,3 +33,3 @@ "use strict";
             }
-            paramsmd.push(`\`: ${type_1.type.call(param.type)}`);
+            paramsmd.push(`\`: *${type_1.type.call(param.type)}*`);
             return paramsmd.join('');
@@ -36,0 +36,0 @@ })

package.json

 {
   "name": "typedoc-plugin-markdown",
-  "version": "2.0.6",
+  "version": "2.0.7",
   "description": "A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

No alert changes

Worsened metrics

Total package byte prevSize

58878

decreased by-1.13%

Lines of code

1244

decreased by-0.08%

No dependency changes