typedoc-plugin-markdown - npm Package Compare versions

Comparing version 4.0.0-next.59 to 4.0.0-next.60

dist/options/declarations.d.ts

@@ -277,7 +277,6 @@ import { DeclarationOption } from 'typedoc';
  *
- * - `header.*` defines text in the page header (if displayed).
- * - `breadcrumbs.*` defines breadcrumbs in page header (if displayed).
- * - `title.*` defines text in main page titles.
- * - `label.*` other text in page content, including content headings and table headers.
- * - `kind.*` defines text mappings to TypeDoc's `ReflectionKind` definitions.
+ * - `header.*`, `breadcrumbs.*`,`footer.*`: Text in main page elements (if displayed).
+ * - `title.*`: Text in main page titles.
+ * - `label.*` Text in page content, including content headings and table headers.
+ * - `kind.*` Text mappings to TypeDoc's `ReflectionKind` definitions.
  *
@@ -284,0 +283,0 @@ * Only keys that require translation need to be added to the object.

dist/options/declarations.js

@@ -375,7 +375,6 @@ "use strict";
  *
- * - `header.*` defines text in the page header (if displayed).
- * - `breadcrumbs.*` defines breadcrumbs in page header (if displayed).
- * - `title.*` defines text in main page titles.
- * - `label.*` other text in page content, including content headings and table headers.
- * - `kind.*` defines text mappings to TypeDoc's `ReflectionKind` definitions.
+ * - `header.*`, `breadcrumbs.*`,`footer.*`: Text in main page elements (if displayed).
+ * - `title.*`: Text in main page titles.
+ * - `label.*` Text in page content, including content headings and table headers.
+ * - `kind.*` Text mappings to TypeDoc's `ReflectionKind` definitions.
  *
@@ -382,0 +381,0 @@ * Only keys that require translation need to be added to the object.

dist/options/option-types.d.ts

@@ -163,5 +163,5 @@ import { ManuallyValidatedOption } from 'typedoc';
     'header.title': string;
-    'header.readme': string;
     'header.docs': string;
     'breadcrumbs.home': string;
+    'footer.text': string;
     'title.indexPage': string;
@@ -168,0 +168,0 @@ 'title.modulePage': string;

dist/options/text-mappings/text-mapping-defaults.d.ts

 export declare const TEXT_MAPPING_DEFAULTS: {
     'header.title': string;
-    'header.readme': string;
     'header.docs': string;
     'breadcrumbs.home': string;
+    'footer.text': string;
     'title.indexPage': string;
@@ -7,0 +7,0 @@ 'title.modulePage': string;

dist/options/text-mappings/text-mapping-defaults.js

@@ -7,5 +7,5 @@ "use strict";
     'header.title': '{projectName} {version}',
-    'header.readme': 'Readme',
     'header.docs': 'Docs',
     'breadcrumbs.home': '{projectName} {version}',
+    'footer.text': '',
     'title.indexPage': '{projectName} {version}',
@@ -12,0 +12,0 @@ 'title.modulePage': '{name}',

dist/theme/markdown-themecontext.d.ts

@@ -196,2 +196,3 @@ import { MarkdownPageEvent } from '../app/events';
         breadcrumbs: () => string;
+        footer: () => string;
         header: () => string;
@@ -198,0 +199,0 @@ packagesIndex: (model: import("typedoc").ProjectReflection) => string;

dist/theme/resources/index.d.ts

@@ -293,2 +293,8 @@ import { MarkdownThemeContext } from '../index.js';
      */
+    footer: () => string;
+    /**
+     *
+     *
+     * @category Page Partials
+     */
     header: () => string;
@@ -295,0 +301,0 @@ /**

dist/theme/resources/index.js

@@ -43,5 +43,6 @@ "use strict";
 const page_breadcrumbs_1 = require("./partials/page.breadcrumbs");
+const page_footer_1 = require("./partials/page.footer");
 const page_header_1 = require("./partials/page.header");
 const page_packagesIndex_1 = require("./partials/page.packagesIndex");
-const page_pageTtitle_1 = require("./partials/page.pageTtitle");
+const page_pageTitle_1 = require("./partials/page.pageTitle");
 const type_array_1 = require("./partials/type.array");
@@ -324,2 +325,8 @@ const type_conditional_1 = require("./partials/type.conditional");
          */
+        footer: () => page_footer_1.footer.apply(context, []),
+        /**
+         *
+         *
+         * @category Page Partials
+         */
         header: () => page_header_1.header.apply(context, []),
@@ -337,3 +344,3 @@ /**
          */
-        pageTitle: () => page_pageTtitle_1.pageTitle.apply(context, []),
+        pageTitle: () => page_pageTitle_1.pageTitle.apply(context, []),
         /**
@@ -340,0 +347,0 @@ *

dist/theme/resources/partials/page.header.js

@@ -56,3 +56,2 @@ "use strict";
             .trim();
-        const readmeLabel = this.getText('header.readme');
         const indexLabel = this.getText('header.docs');
@@ -65,3 +64,2 @@ if (this.page.url === entryFileName) {
         }
-        md.push('•');
         const preserveReadme = Boolean(this.page.project.readme) &&
@@ -73,21 +71,14 @@ !this.options.getValue('mergeReadme');
         if (preserveReadme) {
-            const links = [];
             const readMeUrl = useEntryModule
                 ? `readme_${fileExtension}`
                 : entryFileName;
-            if (this.page.url === readMeUrl) {
-                links.push(readmeLabel);
-            }
-            else {
-                links.push((0, markdown_1.link)(readmeLabel, this.getRelativeUrl(readMeUrl)));
-            }
-            links.push('\\|');
             const indexUrl = useEntryModule ? entryFileName : this.page.project.url;
-            if (this.page.url === readMeUrl) {
-                links.push((0, markdown_1.link)(indexLabel, this.getRelativeUrl(indexUrl || '')));
+            if (indexLabel) {
+                if (this.page.url === readMeUrl) {
+                    md.push((0, markdown_1.link)(indexLabel, this.getRelativeUrl(indexUrl || '')));
+                }
+                else {
+                    md.push(indexLabel);
+                }
             }
-            else {
-                links.push(indexLabel);
-            }
-            md.push(`${links.join(' ')}`);
         }
@@ -97,3 +88,3 @@ else {
         }
-        return `${md.join(' ')}\n\n***\n`;
+        return `${md.join(' • ')}\n\n***\n`;
     };
@@ -106,3 +97,2 @@ const getPackageHeader = () => {
         const md = [];
-        const readmeLabel = this.getText('header.readme');
         const indexLabel = this.getText('header.docs');
@@ -121,20 +111,12 @@ const fileExtension = this.options.getValue('fileExtension');
         }
-        md.push('•');
         const preservePackageReadme = Boolean(packageItem.readme) && !this.options.getValue('mergeReadme');
         if (preservePackageReadme) {
-            const links = [];
-            if (this.page.url === packageEntryFile) {
-                links.push(readmeLabel);
+            if (indexLabel) {
+                if (this.page.url === packageEntryFile) {
+                    md.push((0, markdown_1.link)(indexLabel, this.getRelativeUrl(packageItem.url || '')));
+                }
+                else {
+                    md.push(indexLabel);
+                }
             }
-            else {
-                links.push((0, markdown_1.link)(readmeLabel, this.getRelativeUrl(packageEntryFile)));
-            }
-            links.push('\\|');
-            if (this.page.url === packageEntryFile) {
-                links.push((0, markdown_1.link)(indexLabel, this.getRelativeUrl(packageItem.url || '')));
-            }
-            else {
-                links.push(indexLabel);
-            }
-            md.push(`${links.join(' ')}`);
         }
@@ -144,3 +126,3 @@ else {
         }
-        return `${md.join(' ')}\n\n***\n`;
+        return `${md.join(' • ')}\n\n***\n`;
     };
@@ -147,0 +129,0 @@ function findPackage(model) {

dist/theme/resources/templates/project.js

@@ -46,2 +46,3 @@ "use strict";
     }
+    md.push(this.partials.footer());
     md.push(this.hook('index.page.end').join('\n'));
@@ -48,0 +49,0 @@ return md.join('\n\n');

dist/theme/resources/templates/read-me.js

@@ -19,4 +19,5 @@ "use strict";
     }
+    md.push(this.partials.footer());
     return md.join('\n\n');
 }
 exports.readme = readme;

dist/theme/resources/templates/reflection.js

@@ -35,2 +35,3 @@ "use strict";
     }
+    md.push(this.partials.footer());
     md.push(this.hook('page.end').join('\n'));
@@ -37,0 +38,0 @@ return md.join('\n\n');

package.json

 {
   "name": "typedoc-plugin-markdown",
-  "version": "4.0.0-next.59",
+  "version": "4.0.0-next.60",
   "description": "A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.",
@@ -20,4 +20,5 @@ "main": "dist/index.js",
     "test:update": "npm run build && npm run test -- -u",
-    "predocs": "npm run build",
-    "docs": "typedoc --options ./.docs/typedoc.md.cjs && typedoc --options ./.docs/typedoc.html.cjs"
+    "support": "npm run schema && npm run docs",
+    "schema": "ts-node ./.scripts/schema/generate-schema.ts",
+    "docs": "npm run build && typedoc --options ./.docs/typedoc.json"
   },
@@ -24,0 +25,0 @@ "author": "Thomas Grey",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

303480

increased by0.01%

Number of package files

245

increased by0.82%

Lines of code

7989

increased by0.16%

No dependency changes