typedoc-plugin-markdown - npm Package Compare versions

Comparing version 4.0.0-next.32 to 4.0.0-next.33

dist/plugin/options/config.d.ts

@@ -151,8 +151,11 @@ import { DeclarationOption } from 'typedoc';
 /**
+ * @category other
  */
 export declare const preserveAnchorCasing: DeclarationOption;
 /**
+ * @category other
  */
 export declare const anchorPrefix: DeclarationOption;
 /**
+ *
  * Internal anchor links are used when referencing symbols with in-page table of contents or when referenced with  by {\@link} tags.
@@ -164,3 +167,9 @@ *
  * - `tableRows` - Add anchors to table rows when table formats are selected and no heading elements are present.
+ *
+ * @category other
  */
 export declare const namedAnchors: DeclarationOption;
+/**
+ * @category other
+ */
+export declare const publicPath: DeclarationOption;

dist/plugin/options/config.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.namedAnchors = exports.anchorPrefix = exports.preserveAnchorCasing = exports.indexFormat = exports.typeDeclarationFormat = exports.enumMembersFormat = exports.propertiesFormat = exports.parametersFormat = exports.expandObjects = exports.useCodeBlocks = exports.excludeGroups = exports.memberPageTitle = exports.indexPageTitle = exports.hideInPageTOC = exports.hideBreadcrumbs = exports.hidePageTitle = exports.hidePageHeader = exports.entryModule = exports.entryFileName = exports.membersWithOwnFile = exports.outputFileStrategy = void 0;
+exports.publicPath = exports.namedAnchors = exports.anchorPrefix = exports.preserveAnchorCasing = exports.indexFormat = exports.typeDeclarationFormat = exports.enumMembersFormat = exports.propertiesFormat = exports.parametersFormat = exports.expandObjects = exports.useCodeBlocks = exports.excludeGroups = exports.memberPageTitle = exports.indexPageTitle = exports.hideInPageTOC = exports.hideBreadcrumbs = exports.hidePageTitle = exports.hidePageHeader = exports.entryModule = exports.entryFileName = exports.membersWithOwnFile = exports.outputFileStrategy = void 0;
 const typedoc_1 = require("typedoc");
@@ -258,2 +258,3 @@ const custom_maps_1 = require("./custom-maps");
 /**
+ * @category other
  */
@@ -267,2 +268,3 @@ exports.preserveAnchorCasing = {
 /**
+ * @category other
  */
@@ -276,2 +278,3 @@ exports.anchorPrefix = {
 /**
+ *
  * Internal anchor links are used when referencing symbols with in-page table of contents or when referenced with  by {\@link} tags.
@@ -283,2 +286,4 @@ *
  * - `tableRows` - Add anchors to table rows when table formats are selected and no heading elements are present.
+ *
+ * @category other
  */
@@ -294,1 +299,10 @@ exports.namedAnchors = {
 };
+/**
+ * @category other
+ */
+exports.publicPath = {
+    name: 'publicPath',
+    help: 'Specify the base path for all urls. If undefined urls will be relative.',
+    type: typedoc_1.ParameterType.String,
+    defaultValue: undefined,
+};

dist/plugin/options/models.d.ts

@@ -24,2 +24,3 @@ declare module 'typedoc' {
         namedAnchors: Record<string, boolean>;
+        publicPath: string;
     }
@@ -49,2 +50,3 @@ }
     namedAnchors: Record<string, boolean>;
+    publicPath: string;
 }

dist/theme/render-context.js

@@ -108,2 +108,6 @@ "use strict";
             else {
+                const publicPath = this.options.getValue('publicPath');
+                if (publicPath) {
+                    return path.join(publicPath, url);
+                }
                 const relative = path.relative(path.dirname(((_a = this.page) === null || _a === void 0 ? void 0 : _a.url) || '.'), path.dirname(url));
@@ -110,0 +114,0 @@ return this.parseUrl(path.join(relative, path.basename(url)).replace(/\\/g, '/'));

package.json

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

README.md

@@ -89,2 +89,3 @@ # typedoc-plugin-markdown
 * [`--namedAnchors`](./docs/plugin-options.md#--namedanchors)
+* [`--publicPath`](./docs/plugin-options.md#--publicpath)
 
@@ -91,0 +92,0 @@ ## Contributing

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

203237

increased by0.37%

Lines of code

4741

increased by0.64%

Number of lines in readme file

98

increased by1.03%

No dependency changes