typedoc-plugin-markdown - npm Package Compare versions

Comparing version 4.0.0-next.13 to 4.0.0-next.14

dist/index.d.ts

 /**
- * Exposes the plugin API of the plugin
+ * Exposes the public API of the plugin
  */
 export { load } from './plugin/bootstrap';
+export { PluginOptions } from './plugin/options/models';
 export { MarkdownRendererEvent } from './plugin/renderer';
-export { MarkdownTheme, MarkdownThemeRenderContext } from './theme/definition';
+export { MarkdownTheme, MarkdownThemeRenderContext } from './theme';
 export { NavigationItem } from './theme/models';

dist/index.js

@@ -5,3 +5,3 @@ "use strict";
 /**
- * Exposes the plugin API of the plugin
+ * Exposes the public API of the plugin
  */
@@ -12,4 +12,4 @@ var bootstrap_1 = require("./plugin/bootstrap");
 Object.defineProperty(exports, "MarkdownRendererEvent", { enumerable: true, get: function () { return renderer_1.MarkdownRendererEvent; } });
-var definition_1 = require("./theme/definition");
-Object.defineProperty(exports, "MarkdownTheme", { enumerable: true, get: function () { return definition_1.MarkdownTheme; } });
-Object.defineProperty(exports, "MarkdownThemeRenderContext", { enumerable: true, get: function () { return definition_1.MarkdownThemeRenderContext; } });
+var theme_1 = require("./theme");
+Object.defineProperty(exports, "MarkdownTheme", { enumerable: true, get: function () { return theme_1.MarkdownTheme; } });
+Object.defineProperty(exports, "MarkdownThemeRenderContext", { enumerable: true, get: function () { return theme_1.MarkdownThemeRenderContext; } });

dist/plugin/bootstrap.d.ts

@@ -9,27 +9,3 @@ /**
  * The main plugin entrypoint containing all bootstrapping logic.
- *
- *
- * On a high level:
- *
- * 1. The in-built {@link MarkdownTheme} is added to the application renderer and then replaces the default theme.
- *
- * ```ts
- * app.renderer.defineTheme('markdown', MarkdownTheme);
- *```
- *
- * 2. Additional options are declared using the following pattern.
- *
- * ```ts
- * app.options.addDeclaration({
- *   name: 'newOption`,
- *   help: '[Markdown Plugin] Expose a new option to do something.',
- *   type: ParameterType.String,
- *   defaultValue: 'someDefaultValue',
- * });
- *```
- * 3. Initiates some custom functions on the renderer to decouple HTML logic. See {@link plugin/renderer}.
- *
- * @param app An instance of TypeDoc's Application that serves as the plugin host.
- *
  */
 export declare function load(app: Application): void;

dist/plugin/bootstrap.js

@@ -6,7 +6,29 @@ "use strict";
  */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.load = void 0;
-const typedoc_1 = require("typedoc");
-const models_1 = require("../plugin/models");
-const definition_1 = require("../theme/definition");
+const theme_1 = require("../theme");
+const options = __importStar(require("./options/config"));
 const renderer_1 = require("./renderer");
@@ -16,26 +38,2 @@ /**
  * The main plugin entrypoint containing all bootstrapping logic.
- *
- *
- * On a high level:
- *
- * 1. The in-built {@link MarkdownTheme} is added to the application renderer and then replaces the default theme.
- *
- * ```ts
- * app.renderer.defineTheme('markdown', MarkdownTheme);
- *```
- *
- * 2. Additional options are declared using the following pattern.
- *
- * ```ts
- * app.options.addDeclaration({
- *   name: 'newOption`,
- *   help: '[Markdown Plugin] Expose a new option to do something.',
- *   type: ParameterType.String,
- *   defaultValue: 'someDefaultValue',
- * });
- *```
- * 3. Initiates some custom functions on the renderer to decouple HTML logic. See {@link plugin/renderer}.
- *
- * @param app An instance of TypeDoc's Application that serves as the plugin host.
- *
  */
@@ -46,3 +44,3 @@ function load(app) {
      */
-    app.renderer.defineTheme('markdown', definition_1.MarkdownTheme);
+    app.renderer.defineTheme('markdown', theme_1.MarkdownTheme);
     /**
@@ -69,159 +67,13 @@ * Options reader that sets the Markdown theme as the defaut and initializes other relevant options.
     /**
-     * file output options
+     * add options
      */
-    app.options.addDeclaration({
-        name: 'outputFileStrategy',
-        help: '[Markdown Plugin] Determines how files are rendered.',
-        type: typedoc_1.ParameterType.Map,
-        map: models_1.OutputFileStrategy,
-        defaultValue: models_1.OutputFileStrategy.Members,
+    Object.values(options).forEach((option) => {
+        app.options.addDeclaration({
+            ...option,
+            help: `[typedoc-plugin-markdown] ${option.help}`,
+        });
     });
-    app.options.addDeclaration({
-        name: 'flattenOutputFiles',
-        help: '[Markdown Plugin] Flatten output files without folders.',
-        type: typedoc_1.ParameterType.Boolean,
-        defaultValue: false,
-    });
-    app.options.addDeclaration({
-        name: 'includeFileNumberPrefixes',
-        help: '[Markdown Plugin] Prefixes docs and folders by number prefixes if applicable.',
-        type: typedoc_1.ParameterType.Boolean,
-        defaultValue: false,
-    });
-    app.options.addDeclaration({
-        name: 'excludeGroups',
-        help: '[Markdown Plugin] Groups reflection kinds by headings if applicable e.g Classes, Functions. If set to false all symbols will render on the same level. Defaults to `true`',
-        type: typedoc_1.ParameterType.Boolean,
-        defaultValue: false,
-    });
-    app.options.addDeclaration({
-        name: 'entryFileName',
-        help: '[Markdown Plugin] The file name of the entry document.',
-        type: typedoc_1.ParameterType.String,
-        defaultValue: 'README.md',
-    });
-    app.options.addDeclaration({
-        name: 'indexFileName',
-        help: '[Markdown Plugin] The file name of the seperate index page. ',
-        type: typedoc_1.ParameterType.String,
-        defaultValue: 'API.md',
-    });
-    app.options.addDeclaration({
-        name: 'indexPageTitle',
-        help: '[Markdown Plugin] The title of the main index / modules page.',
-        type: typedoc_1.ParameterType.String,
-    });
-    app.options.addDeclaration({
-        name: 'skipIndexPage',
-        help: '[Markdown Plugin] How the globals page should be written.',
-        type: typedoc_1.ParameterType.Boolean,
-        defaultValue: false,
-    });
     /**
-     * ui options
-     */
-    app.options.addDeclaration({
-        name: 'hidePageHeader',
-        help: '[Markdown Plugin] Do not print page header.',
-        type: typedoc_1.ParameterType.Boolean,
-        defaultValue: false,
-    });
-    app.options.addDeclaration({
-        name: 'hidePageTitle',
-        help: '[Markdown Plugin] Do not print page title.',
-        type: typedoc_1.ParameterType.Boolean,
-        defaultValue: false,
-    });
-    app.options.addDeclaration({
-        name: 'hideKindPrefix',
-        help: '[Markdown Plugin] Do not print the kind label as a title prefix',
-        type: typedoc_1.ParameterType.Boolean,
-        defaultValue: false,
-    });
-    app.options.addDeclaration({
-        name: 'hideBreadcrumbs',
-        help: '[Markdown Plugin] Do not print breadcrumbs.',
-        type: typedoc_1.ParameterType.Boolean,
-        defaultValue: false,
-    });
-    app.options.addDeclaration({
-        name: 'hideInPageTOC',
-        help: '[Markdown Plugin] Do not render in-page table of contents items.',
-        type: typedoc_1.ParameterType.Boolean,
-        defaultValue: false,
-    });
-    app.options.addDeclaration({
-        name: 'hideHierarchy',
-        help: '[Markdown Plugin] Do not print reflection hierarchy.',
-        type: typedoc_1.ParameterType.Boolean,
-        defaultValue: false,
-    });
-    app.options.addDeclaration({
-        name: 'identifiersAsCodeBlocks',
-        help: '[Markdown Plugin] Format signature and declaration identifiers in code blocks.',
-        type: typedoc_1.ParameterType.Boolean,
-        defaultValue: false,
-    });
-    app.options.addDeclaration({
-        name: 'propertiesFormat',
-        help: '[Markdown Plugin] Specify the render style of properties.',
-        type: typedoc_1.ParameterType.Map,
-        map: models_1.FormatStyle,
-        defaultValue: models_1.FormatStyle.List,
-    });
-    app.options.addDeclaration({
-        name: 'enumMembersFormat',
-        help: '[Markdown Plugin] Specify the render style of enum members.',
-        type: typedoc_1.ParameterType.Map,
-        map: models_1.FormatStyle,
-        defaultValue: models_1.FormatStyle.List,
-    });
-    app.options.addDeclaration({
-        name: 'typeDeclarationFormat',
-        help: '[Markdown Plugin] Specify the render style of type declration members.',
-        type: typedoc_1.ParameterType.Map,
-        map: models_1.FormatStyle,
-        defaultValue: models_1.FormatStyle.List,
-    });
-    app.options.addDeclaration({
-        name: 'tocFormat',
-        help: '[Markdown Plugin] Render TOC with first line of member descriptions.',
-        type: typedoc_1.ParameterType.Map,
-        map: models_1.FormatStyle,
-        defaultValue: models_1.FormatStyle.List,
-    });
-    /**
-     * Utility options
-     */
-    app.options.addDeclaration({
-        help: '[Markdown Plugin] Specifies the base url for internal link. If omitted all urls will be relative.',
-        name: 'baseUrl',
-        type: typedoc_1.ParameterType.String,
-    });
-    app.options.addDeclaration({
-        name: 'anchorFormat',
-        help: '[Markdown Plugin] The anchor format to use when linking to internal symbols.',
-        type: typedoc_1.ParameterType.Map,
-        map: models_1.AnchorFormat,
-        defaultValue: models_1.AnchorFormat.Lowercase,
-    });
-    app.options.addDeclaration({
-        name: 'anchorPattern',
-        help: '[Markdown Plugin] The anchor pattern to use when linking to internal symbols. e.g customprefix-{{anchor}}.',
-        type: typedoc_1.ParameterType.String,
-    });
-    app.options.addDeclaration({
-        name: 'namedAnchors',
-        help: '[Markdown Plugin] Use HTML named anchors as fragment identifiers for engines that do not automatically assign header ids. Should be set for Bitbucket Server docs.',
-        type: typedoc_1.ParameterType.Boolean,
-        defaultValue: false,
-    });
-    app.options.addDeclaration({
-        name: 'preserveAnchorCasing',
-        help: '[Markdown Plugin] Preserve anchor casing when generating links.',
-        type: typedoc_1.ParameterType.Boolean,
-        defaultValue: false,
-    });
-    /**
      * Apply custom renderer methods (there should probably be a better solution to this)
+     * See {@link plugin/renderer}.
      */
@@ -228,0 +80,0 @@ Object.defineProperty(app, 'generateDocs', { value: renderer_1.generateMarkdown });

dist/theme/resources/partials/breadcrumbs.d.ts

 import { DeclarationReflection, PageEvent, ProjectReflection } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * Renders the breadcrumbs

dist/theme/resources/partials/comment.d.ts

 import { Comment } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Partials

dist/theme/resources/partials/comment.parts.d.ts

 import { CommentDisplayPart } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Partials

dist/theme/resources/partials/footer.d.ts

@@ -1,2 +0,2 @@
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -3,0 +3,0 @@ * @category Partials

dist/theme/resources/partials/header.d.ts

 import { DeclarationReflection, PageEvent, ProjectReflection } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Partials

dist/theme/resources/partials/header.js

@@ -80,3 +80,3 @@ "use strict";
     const hasReadme = Boolean(packageItem.readme);
-    const readmeUrl = `${path.dirname(packageItem.url)}/${context.options.getValue('entryFileName')}`;
+    const readmeUrl = `${path.dirname(packageItem.url || '')}/${context.options.getValue('entryFileName')}`;
     const md = [];
@@ -83,0 +83,0 @@ md.push((0, elements_1.link)((0, elements_1.bold)(packageItem.name), context.relativeURL(packageItem.url)));

dist/theme/resources/partials/member.d.ts

 import { DeclarationReflection } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Partials

dist/theme/resources/partials/member.declaration.accessort.d.ts

 import { DeclarationReflection } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Partials

dist/theme/resources/partials/member.declaration.d.ts

 import { DeclarationReflection } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Partials

dist/theme/resources/partials/member.declaration.identifier.d.ts

 import { DeclarationReflection } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Partials

dist/theme/resources/partials/member.hierarchy.d.ts

 import { DeclarationHierarchy } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition';
+import { MarkdownThemeRenderContext } from '../..';
 export declare function memberHierarchy(context: MarkdownThemeRenderContext, declarationHierarchy: DeclarationHierarchy, headingLevel: number): string;

dist/theme/resources/partials/member.indexsignature.title.d.ts

 import { SignatureReflection } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Partials

dist/theme/resources/partials/member.inheritance.d.ts

 import { DeclarationReflection, SignatureReflection } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition';
+import { MarkdownThemeRenderContext } from '../..';
 export declare function inheritance(context: MarkdownThemeRenderContext, reflection: DeclarationReflection | SignatureReflection, headingLevel: number): string;

dist/theme/resources/partials/member.reference.d.ts

 import { ReferenceReflection } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Partials

dist/theme/resources/partials/member.reflection.d.ts

 import { DeclarationReflection } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Partials

dist/theme/resources/partials/member.signature.d.ts

 import { SignatureReflection } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Partials

dist/theme/resources/partials/member.signature.identifier.d.ts

 import { SignatureReflection } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Partials

dist/theme/resources/partials/member.sources.d.ts

 import { DeclarationReflection, SignatureReflection } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Partials

dist/theme/resources/partials/member.title.d.ts

 import { DeclarationReflection } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Partials

dist/theme/resources/partials/member.title.js

@@ -30,18 +30,7 @@ "use strict";
 function hasKindTag(context, reflection) {
-    if (context.options.getValue('hideKindPrefix')) {
-        return false;
-    }
     if (reflection.hasOwnDocument &&
-        !reflection.kindOf([typedoc_1.ReflectionKind.Module, typedoc_1.ReflectionKind.Namespace])) {
+        !context.options.getValue('hideKindPrefix')) {
         return true;
     }
-    return (context.options.getValue('excludeGroups') &&
-        reflection.kindOf([
-            typedoc_1.ReflectionKind.Function,
-            typedoc_1.ReflectionKind.Class,
-            typedoc_1.ReflectionKind.Interface,
-            typedoc_1.ReflectionKind.Variable,
-            typedoc_1.ReflectionKind.TypeAlias,
-            typedoc_1.ReflectionKind.Enum,
-        ]));
+    return false;
 }

dist/theme/resources/partials/member.toc.d.ts

 import { DeclarationReflection, ProjectReflection } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition';
+import { MarkdownThemeRenderContext } from '../..';
 export declare function memberTOC(context: MarkdownThemeRenderContext, reflection: ProjectReflection | DeclarationReflection, headingLevel: number): string;

dist/theme/resources/partials/member.toc.js

@@ -5,3 +5,2 @@ "use strict";
 const typedoc_1 = require("typedoc");
-const models_1 = require("../../../plugin/models");
 const elements_1 = require("../../../support/elements");
@@ -53,3 +52,3 @@ const utils_1 = require("../../../support/utils");
 function getGroup(context, group) {
-    if (context.options.getValue('tocFormat') === models_1.FormatStyle.Table) {
+    if (context.options.getValue('tocFormat') === 'table') {
         return getTable(context, group);
@@ -56,0 +55,0 @@ }

dist/theme/resources/partials/member.type-declaration.d.ts

 import { DeclarationReflection } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Partials

dist/theme/resources/partials/member.type-declaration.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.typeDeclarationMember = void 0;
-const models_1 = require("../../../plugin/models");
 const elements_1 = require("../../../support/elements");
@@ -13,3 +12,3 @@ const utils_1 = require("../../../support/utils");
     if (typeDeclaration.children) {
-        if (context.options.getValue('typeDeclarationFormat') === models_1.FormatStyle.Table) {
+        if (context.options.getValue('typeDeclarationFormat') === 'table') {
             md.push(context.propertiesTable(typeDeclaration.children, 'Member'));
@@ -16,0 +15,0 @@ }

dist/theme/resources/partials/members.d.ts

 import { ContainerReflection } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition';
+import { MarkdownThemeRenderContext } from '../..';
 export declare function members(context: MarkdownThemeRenderContext, container: ContainerReflection, headingLevel: number): string;

dist/theme/resources/partials/members.js

@@ -5,3 +5,2 @@ "use strict";
 const typedoc_1 = require("typedoc");
-const models_1 = require("../../../plugin/models");
 const elements_1 = require("../../../support/elements");
@@ -54,8 +53,7 @@ function members(context, container, headingLevel) {
                     if (isPropertiesGroup &&
-                        context.options.getValue('propertiesFormat') === models_1.FormatStyle.Table) {
+                        context.options.getValue('propertiesFormat') === 'table') {
                         md.push(context.propertiesTable(group.children));
                     }
                     else if (isEnumGroup &&
-                        context.options.getValue('enumMembersFormat') ===
-                            models_1.FormatStyle.Table) {
+                        context.options.getValue('enumMembersFormat') === 'table') {
                         md.push(context.enumMembersTable(group.children));
@@ -62,0 +60,0 @@ }

dist/theme/resources/partials/navigation.d.ts

@@ -0,3 +1,3 @@
+import { MarkdownThemeRenderContext } from '../..';
 import { NavigationItem } from '../../../theme/models';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
 /**
@@ -4,0 +4,0 @@ * @category Partials

dist/theme/resources/partials/page.title.d.ts

 import { DeclarationReflection, PageEvent, ProjectReflection } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Partials

dist/theme/resources/partials/page.toc.d.ts

 import { DeclarationReflection, PageEvent, ProjectReflection } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Partials

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

@@ -29,3 +29,2 @@ "use strict";
 const typedoc_1 = require("typedoc");
-const models_1 = require("../../../plugin/models");
 const elements_1 = require("../../../support/elements");
@@ -60,3 +59,3 @@ const utils_1 = require("../../../support/utils");
 function getGroup(context, group) {
-    if (context.options.getValue('tocFormat') === models_1.FormatStyle.Table) {
+    if (context.options.getValue('tocFormat') === 'table') {
         return getTable(context, group);
@@ -63,0 +62,0 @@ }

dist/theme/resources/partials/table.enum-members.d.ts

 import { DeclarationReflection } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Partials

dist/theme/resources/partials/table.parameters.d.ts

 import { ParameterReflection } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Partials

dist/theme/resources/partials/table.properties.d.ts

 import { DeclarationReflection } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Partials

dist/theme/resources/partials/table.typeparameters.d.ts

 import { TypeParameterReflection } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Partials

dist/theme/resources/partials/type.array.d.ts

 import { ArrayType } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Partials

dist/theme/resources/partials/type.conditional.d.ts

 import { ConditionalType } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Partials

dist/theme/resources/partials/type.declaration.d.ts

 import { DeclarationReflection } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Partials

dist/theme/resources/partials/type.function.d.ts

 import { SignatureReflection } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Partials

dist/theme/resources/partials/type.index-access.d.ts

 import { IndexedAccessType } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Partials

dist/theme/resources/partials/type.inferred.d.ts

 import { InferredType } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Partials

dist/theme/resources/partials/type.intersection.d.ts

 import { IntersectionType } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Partials

dist/theme/resources/partials/type.intrinsic.d.ts

 import { IntrinsicType } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Partials

dist/theme/resources/partials/type.literal.d.ts

 import { LiteralType } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Partials

dist/theme/resources/partials/type.named-tuple.d.ts

 import { NamedTupleMember } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Partials

dist/theme/resources/partials/type.query.d.ts

 import { QueryType } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Partials

dist/theme/resources/partials/type.reference.d.ts

 import { ReferenceType } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Partials

dist/theme/resources/partials/type.reflection.d.ts

 import { ReflectionType } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Partials

dist/theme/resources/partials/type.some.d.ts

 import { SomeType } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Partials

dist/theme/resources/partials/type.tuple.d.ts

 import { TupleType } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Partials

dist/theme/resources/partials/type.type-operator.d.ts

 import { TypeOperatorType } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Partials

dist/theme/resources/partials/type.union.d.ts

 import { UnionType } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Partials

dist/theme/resources/partials/type.unknown.d.ts

 import { UnknownType } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Partials

dist/theme/resources/templates/member.d.ts

 import { DeclarationReflection, PageEvent } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Templates

dist/theme/resources/templates/project.d.ts

 import { PageEvent, ProjectReflection } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Templates

dist/theme/resources/templates/read-me.d.ts

 import { DeclarationReflection, PageEvent, ProjectReflection } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Templates

dist/theme/resources/templates/reflection.d.ts

 import { DeclarationReflection, PageEvent } from 'typedoc';
-import { MarkdownThemeRenderContext } from '../../definition/markdown-theme-render-context';
+import { MarkdownThemeRenderContext } from '../..';
 /**
@@ -4,0 +4,0 @@ * @category Templates

package.json

 {
   "name": "typedoc-plugin-markdown",
-  "version": "4.0.0-next.13",
+  "version": "4.0.0-next.14",
   "description": "A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.",
@@ -14,3 +14,3 @@ "main": "dist/index.js",
     "prepublishOnly": "npm run lint && npm run build && npm run test",
-    "prebuild": "ts-node scripts/build-resources",
+    "prebuild": "npm-run-all task:*",
     "build": "rm -rf dist && tsc",
@@ -21,6 +21,8 @@ "test": "jest --colors --updateSnapshot",
     "docs": "npm run build && npm-run-all docs:*",
-    "docs:md-1": "typedoc --options ../../stubs/typedoc.1.js --out ./out/md/md-1",
-    "docs:md-2": "typedoc --options ../../stubs/typedoc.2.js --out ./out/md/md-2",
-    "docs:md-3": "typedoc --options ../../stubs/typedoc.3.js --out ./out/md/md-3",
-    "docs:html": "typedoc --options ../../stubs/typedoc.base.js  --out ./out/html"
+    "docs:md-1": "typedoc --options ../../stubs/.config/typedoc.1.cjs --out ./out/md/md-1",
+    "docs:md-2": "typedoc --options ../../stubs/.config/typedoc.2.cjs --out ./out/md/md-2",
+    "docs:md-3": "typedoc --options ../../stubs/.config/typedoc.3.cjs --out ./out/md/md-3",
+    "docs:html": "typedoc --options ../../stubs/.config/typedoc.base.cjs  --out ./out/html",
+    "task:build-options": "ts-node scripts/build-options",
+    "task:build-resources": "ts-node scripts/build-resources"
   },
@@ -43,3 +45,3 @@ "author": "Thomas Grey",
     "api",
-    "typedocplugin",
+    "typedoc-plugin",
     "typedoc"
@@ -50,6 +52,3 @@ ],
     "typedoc": ">=0.24.0"
-  },
-  "devDependencies": {
-    "typedoc-plugin-merge-modules": "^5.0.0"
   }
 }

README.md

@@ -61,63 +61,103 @@ # typedoc-plugin-markdown
 
-More detailed documentation with examples can be found in the following:
+Please see [options guide](./docs/usage/options.md) for more detailed descriptions of available plugin options.
 
-- [File output and content organization options]()
-
 Below is a summary of the available options:
 
-### File output and content organization options
+<!-- DO NOT EDIT THE OPTIONS BELOW DIRECTLY - THEY ARE INJECTED DYNAMICALLY FROM OPTIONS CONFIG -->
 
-- **`--outputFileStrategy`**<br>
-  Determines how output files are generated. Allowed values `modules` (all symbols hoisted to a single modules file) or `members` (each symbol exported to a seperate file as per HTML theme). Default to `members`.
-- **`--includeFileNumberPrefixes`**<br>
-  Prefixes generated files and folders with number prefixes. This is useful for implementations that support auto sidebar generation. Defaults to `false`.
-- **`--flattenOutputFiles`**<br>
-  Flatten output files without folders. Defaults to `false`.
-- **`--entryFileName`**<br>
-  The file name of the entry page (either project readme or API index if readme=none). `README.md` is recognised when browsing folders on repos and Wikis, while using `index.md`. Defaults to `README.md`.
-- **`--indexFileName`**<br>
-  The file name the seperate index page. Ignored if readme=none or skipIndexPage=true. Default to `API.md`.
-- **`--skipIndexPage`**<br>
-  Skips generation of a seperate API index page. Note the index page can be inserted into the readme page using the `$TYPEDOC_INDEX` placeholder key. Ignored if readme=none. Defaults to `false`.
-- **`--indexPageTitle`**<br>
-  The title of API index page. Defaults to the project name.
-- **`--excludeGroups`**<br>
-  By default members are grouped by kind (eg Classes, Functions etc). This option excludes such groupings so all members are rendered and sorted at the same level. Defaults to `false`.
+<!-- START OPTIONS -->
+**`--outputFileStrategy`** `"members" | "modules"`
 
-### UI options
+> Determines how output files are generated. Defaults to `members`. <small>[more »](./docs/usage/options.md#outputfilestrategy)</small>
 
-- **`--hidePageHeader`**<br>
-  Do not print the page header. Defaults to `false`.
-- **`--hideBreadcrumbs`**<br>
-  Do not print breadcrumbs. Defaults to `false`.
-- **`--hideInPageTOC`**<br>
-  Do not print in-page index items. Defaults to `false`.
-- **`--hidePageTitle`**<br>
-  Do not print the page title. Defaults to `false`.
-- **`--hideKindPrefix`**<br>
-  Do not print the kind label as a title prefix. Defaults to `false`.
-- **`--hideHierarchy`**<br>
-  Do not print reflection hierarchy. Defaults to `false`.
-- **`--identifiersAsCodeBlocks`**<br>
-  Format signature and declaration identifiers in code blocks. Note if `true` references will not be linked. Defaults to `false`.
-- **`--propertiesFormat`**<br>
-  Specify the render style of properties groups for interfaces, classes and type literals. Expected values [`list`, `table`]. Defaults to `list`.
-- **`--enumMembersFormat`**<br>
-  Specify the render style of Enum members. Expected values [`list`, `table`]. Defaults to `list`.
-- **`--typeDeclarationFormat`**<br>
-  Specify the render style for type declaration members. Expected values [`list`, `table`]. Defaults to `list`.
-- **`--tocFormat`**<br>
-  Render TOC with first line of member descriptions. Expected values [`list`, `table`]. Defaults to `list`.
+**`--includeFileNumberPrefixes`** `boolean`
 
-### Utility options
+> Prefixes generated files and folders with number prefixes. Defaults to `false`. <small>[more »](./docs/usage/options.md#includefilenumberprefixes)</small>
 
-- **`--baseUrl`**<br>
-  Specifies the base url for internal link. If omitted all urls will be relative. Defaults to `.`
-- **`--anchorFormat`**<br>
-  The anchor style to use when linking to internal symbols. Expected values [`lowercase`, `slug`, `none`]. Defaults to `lowercase`.
-- **`--anchorPattern`**<br>
-  The anchor pattern to use when linking to internal symbols. e.g customprefix-{{anchor}}.
-- **`--namedAnchors`**<br>
-  Use HTML named anchor tags for implementations that do not assign header ids. Defaults to `false`.
+**`--flattenOutputFiles`** `boolean`
 
+> Flatten output files without folders. Defaults to `false`. <small>[more »](./docs/usage/options.md#flattenoutputfiles)</small>
+
+**`--entryFileName`** `string`
+
+> The file name of the entry page. Defaults to `README.md`. <small>[more »](./docs/usage/options.md#entryfilename)</small>
+
+**`--indexFileName`** `string`
+
+> The file name the seperate index page. Defaults to `API.md`. <small>[more »](./docs/usage/options.md#indexfilename)</small>
+
+**`--indexPageTitle`** `string`
+
+> The title of API index page. Defaults to `undefined`. <small>[more »](./docs/usage/options.md#indexpagetitle)</small>
+
+**`--skipIndexPage`** `boolean`
+
+> Skips generation of a seperate API index page. Defaults to `false`. <small>[more »](./docs/usage/options.md#skipindexpage)</small>
+
+**`--excludeGroups`** `boolean`
+
+> Excludes grouping by reflection kind so all members are rendered and sorted at the same level. Defaults to `false`. <small>[more »](./docs/usage/options.md#excludegroups)</small>
+
+**`--hidePageHeader`** `boolean`
+
+> Do not print page header. Defaults to `false`.
+
+**`--hidePageTitle`** `boolean`
+
+> Do not print page title. Defaults to `false`.
+
+**`--hideKindPrefix`** `boolean`
+
+> Do not print the kind label as a title prefix. Defaults to `false`.
+
+**`--hideBreadcrumbs`** `boolean`
+
+> Do not print breadcrumbs. Defaults to `false`.
+
+**`--hideInPageTOC`** `boolean`
+
+> Do not render in-page table of contents items. Defaults to `false`.
+
+**`--hideHierarchy`** `boolean`
+
+> Do not print reflection hierarchy. Defaults to `false`.
+
+**`--identifiersAsCodeBlocks`** `boolean`
+
+> Format signature and declaration identifiers in code blocks. Defaults to `false`. <small>[more »](./docs/usage/options.md#identifiersascodeblocks)</small>
+
+**`--propertiesFormat`** `"list" | "table"`
+
+> Specify the render style of properties groups for interfaces and classes. Defaults to `list`.
+
+**`--enumMembersFormat`** `"list" | "table"`
+
+> Specify the render style of Enum members. Defaults to `list`.
+
+**`--typeDeclarationFormat`** `"list" | "table"`
+
+> Specify the render style for type declaration members. Defaults to `list`.
+
+**`--tocFormat`** `"list" | "table"`
+
+> Render TOC either as a simple list or a table with a description. Defaults to `list`.
+
+**`--baseUrl`** `string`
+
+> Specifies the base url for internal link. If omitted all urls will be relative. Defaults to `undefined`.
+
+**`--anchorFormat`** `"lowercase" | "slug" | "none"`
+
+> The anchor format to use when linking to internal symbols. Defaults to `lowercase`.
+
+**`--anchorPattern`** `string`
+
+> The anchor pattern to use when linking to internal symbols. Defaults to `undefined`. <small>[more »](./docs/usage/options.md#anchorpattern)</small>
+
+**`--namedAnchors`** `boolean`
+
+> Use HTML named anchors for engines that do not automatically assign header ids. Defaults to `false`.
+
+<!-- END OPTIONS -->
+
 ## Adding Frontmatter
@@ -124,0 +164,0 @@

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

178317

3.38%

Dev dependency count

0

-100%

Number of package files

139

2.96%

Lines of code

4133

6.03%

Number of lines in readme file

199

25.16%

Number of medium supply chain risk alerts

0

-100%

No dependency changes