typedoc-plugin-markdown - npm Package Compare versions

Comparing version 2.0.11 to 2.1.0

dist/index.js

@@ -23,2 +23,20 @@ "use strict";
         component: 'markdown',
+        help: 'Markdown Plugin: Prevent breadcrumbs from rendering in output.',
+        name: 'hideBreadcrumbs',
+        type: declaration_1.ParameterType.Boolean,
+    });
+    app.options.addDeclaration({
+        component: 'markdown',
+        help: 'Markdown Plugin: Prevent indexes from rendering in output.',
+        name: 'hideIndexes',
+        type: declaration_1.ParameterType.Boolean,
+    });
+    app.options.addDeclaration({
+        component: 'markdown',
+        help: 'Markdown Plugin: Use HTML named anchors as fragment identifiers for engines that do not automatically assign header ids.',
+        name: 'namedAnchors',
+        type: declaration_1.ParameterType.Boolean,
+    });
+    app.options.addDeclaration({
+        component: 'markdown',
         help: 'Markdown Plugin: Deprectated - use --platform.',
@@ -25,0 +43,0 @@ name: 'mdEngine',

dist/plugin.js

@@ -8,4 +8,4 @@ "use strict";
 };
+var MarkdownPlugin_1;
 Object.defineProperty(exports, "__esModule", { value: true });
-var MarkdownPlugin_1;
 const path = require("path");
@@ -60,3 +60,4 @@ const typedoc_1 = require("typedoc");
         if (theme) {
-            if (media && (theme instanceof theme_docusaurus_1.DocusaurusTheme || theme instanceof theme_gitbook_1.GitbookTheme || theme instanceof theme_vuepress_1.VuePressTheme)) {
+            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`);
@@ -63,0 +64,0 @@ options.setValue('media', null);

dist/theme/helpers/breadcrumbs.js

@@ -27,3 +27,5 @@ "use strict";
 function isVisible() {
-    if (plugin_1.MarkdownPlugin.theme instanceof theme_gitbook_1.GitbookTheme || plugin_1.MarkdownPlugin.theme instanceof theme_vuepress_1.VuePressTheme) {
+    if (plugin_1.MarkdownPlugin.settings.hideBreadcrumbs ||
+        plugin_1.MarkdownPlugin.theme instanceof theme_gitbook_1.GitbookTheme ||
+        plugin_1.MarkdownPlugin.theme instanceof theme_vuepress_1.VuePressTheme) {
         return false;
@@ -30,0 +32,0 @@ }

dist/theme/helpers/if-display-index.js

@@ -6,3 +6,3 @@ "use strict";
 function ifDisplayIndex(options) {
-    if (plugin_1.MarkdownPlugin.theme instanceof theme_vuepress_1.VuePressTheme) {
+    if (plugin_1.MarkdownPlugin.settings.hideIndexes || plugin_1.MarkdownPlugin.theme instanceof theme_vuepress_1.VuePressTheme) {
         return options.inverse(this);
@@ -9,0 +9,0 @@ }

dist/theme/helpers/member-title.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const plugin_1 = require("../../plugin");
 const heading_1 = require("./heading");
 function memberTitle() {
     const md = [heading_1.heading(3)];
+    if (plugin_1.MarkdownPlugin.settings.namedAnchors) {
+        md.push(`<a name="${this.anchor}"></a>`);
+    }
     if (this.flags) {
@@ -7,0 +11,0 @@ md.push(this.flags.map(flag => `\`${flag}\``).join(' '));

dist/theme/theme.js

@@ -219,2 +219,3 @@ "use strict";
             reflection.url = container.url + '#' + this.getAnchor(reflection);
+            reflection.anchor = this.getAnchor(reflection);
             reflection.hasOwnDocument = false;
@@ -221,0 +222,0 @@ }

package.json

 {
   "name": "typedoc-plugin-markdown",
-  "version": "2.0.11",
+  "version": "2.1.0",
   "description": "A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.",
@@ -43,2 +43,3 @@ "main": "dist/index.js",
     "@types/jest": "^24.0.15",
+    "@types/node": "^12.6.8",
     "arg": "^4.1.1",
@@ -52,6 +53,6 @@ "chalk": "^2.4.2",
     "tslint": "^5.18.0",
-    "typedoc": "0.14.2",
-    "typescript": "3.4.x"
+    "typedoc": "0.15.0",
+    "typescript": "3.5.x"
   },
   "dependencies": {}
 }

README.md

@@ -27,5 +27,11 @@ # typedoc-plugin-markdown
 - `--platform <docusaurus|vuepress|gitbook|bitbucket>`<br>
-  Target a specific documentation/hosting platform (see [Wiki page](https://github.com/tgreyuk/typedoc-plugin-markdown/wiki/1.-Targeting-Platforms) for further documentation),
+  Attempt to target a specific documentation/hosting platform (see [Wiki page](https://github.com/tgreyuk/typedoc-plugin-markdown/wiki/1.-Targeting-Platforms)) for further docs.
 - `--hideSources`<br>
   Suppress source file linking from output.
+- `--hideBreadcrumbs`<br>
+  Prevent breadcrumbs from rendering in output.
+- `--hideIndexes`<br>
+  Prevent indexes from rendering in output.
+- `--namedAnchors`<br>
+  Use HTML named anchors as fragment identifiers for engines that do not automatically assign header ids.
 
@@ -32,0 +38,0 @@ ## Acknowledgements

No alert changes

Improved metrics

Total package byte prevSize

60104

increased by2.39%

Lines of code

1276

increased by2.08%

Number of lines in readme file

40

increased by17.65%

Worsened metrics

Dev dependency count

12

increased by9.09%

No dependency changes