typedoc-plugin-markdown - npm Package Compare versions

Comparing version 2.1.1 to 2.1.2

dist/index.js

@@ -17,2 +17,8 @@ "use strict";
         component: 'markdown',
+        help: 'Markdown Plugin: Suppress project title (Home/README link) rendering.',
+        name: 'hideProjectTitle',
+        type: declaration_1.ParameterType.Boolean,
+    });
+    app.options.addDeclaration({
+        component: 'markdown',
         help: 'Markdown Plugin: Suppress file sources from output.',
@@ -19,0 +25,0 @@ name: 'hideSources',

dist/theme/helpers/breadcrumbs.js

@@ -11,16 +11,19 @@ "use strict";
     }
-    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);
+    return breadcrumb(this.model, this.project, []);
 }
 exports.breadcrumbs = breadcrumbs;
-function breadcrumb(model, md) {
+function breadcrumb(model, project, md) {
     if (model && model.parent) {
-        breadcrumb(model.parent, md);
+        breadcrumb(model.parent, project, md);
         if (model.url) {
-            md.push(`[${model.name}](${relative_url_1.relativeUrl(model.url)}) /`);
+            md.push(`[${model.name}](${relative_url_1.relativeUrl(model.url)})`);
         }
+        else {
+            md.push(model.url);
+        }
     }
-    return md.join(' ');
+    else {
+        md.push(`[Globals](${relative_url_1.relativeUrl(project.url)})`);
+    }
+    return md.join(' › ');
 }
@@ -27,0 +30,0 @@ function isVisible() {

dist/theme/helpers/project-title.js

@@ -12,7 +12,8 @@ "use strict";
     }
-    return `> **[${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)})**`;
 }
 exports.projectTitle = projectTitle;
 function isVisible() {
-    if (plugin_1.MarkdownPlugin.theme instanceof theme_docusaurus_1.DocusaurusTheme ||
+    if (plugin_1.MarkdownPlugin.settings.hideProjectTitle ||
+        plugin_1.MarkdownPlugin.theme instanceof theme_docusaurus_1.DocusaurusTheme ||
         plugin_1.MarkdownPlugin.theme instanceof theme_gitbook_1.GitbookTheme ||
@@ -19,0 +20,0 @@ plugin_1.MarkdownPlugin.theme instanceof theme_vuepress_1.VuePressTheme) {

package.json

 {
   "name": "typedoc-plugin-markdown",
-  "version": "2.1.1",
+  "version": "2.1.2",
   "description": "A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.",
@@ -18,3 +18,3 @@ "main": "dist/index.js",
   },
-  "author": "Tom Grey",
+  "author": "Thomas Grey",
   "license": "MIT",
@@ -43,4 +43,4 @@ "engines": {
   "devDependencies": {
-    "@types/jest": "^24.0.15",
-    "@types/node": "^12.6.8",
+    "@types/jest": "^24.0.17",
+    "@types/node": "^12.7.2",
     "arg": "^4.1.1",
@@ -50,3 +50,3 @@ "chalk": "^2.4.2",
     "cross-spawn": "^6.0.5",
-    "jest": "^24.8.0",
+    "jest": "^24.9.0",
     "prettier": "^1.18.2",
@@ -53,0 +53,0 @@ "ts-jest": "^24.0.2",

README.md

@@ -26,3 +26,3 @@ # typedoc-plugin-markdown
 
-The plugin exposes the following additional arguments:
+**Configuring output**
 
@@ -33,8 +33,13 @@ - `--platform <docusaurus|vuepress|gitbook|bitbucket>`<br>
   Use HTML named anchors as fragment identifiers for engines that do not automatically assign header ids.
-- `--hideSources`<br>
-  Suppress source file links from rendering from output.
+
+**Controlling the visibility of components**
+
+- `--hideProjectTitle`<br>
+  Suppress project title (Home/README link) rendering.
 - `--hideBreadcrumbs`<br>
-  Suppress breadcrumbs from rendering in output.
+  Suppress breadcrumb rendering.
 - `--hideIndexes`<br>
-  Suppress indexes from rendering in output.
+  Suppress indexes rendering.
+- `--hideSources`<br>
+  Suppress source file link rendering.
 
@@ -41,0 +46,0 @@ ## Acknowledgements

No alert changes

Improved metrics

Total package byte prevSize

60526

increased by0.44%

Lines of code

1286

increased by0.78%

Number of lines in readme file

47

increased by11.9%

No dependency changes