typedoc-plugin-markdown - npm Package Compare versions

Comparing version 4.0.0-next.21 to 4.0.0-next.22

dist/plugin/options/config.d.ts

@@ -90,8 +90,2 @@ import { DeclarationOption } from 'typedoc';
 /**
- * This option is ignored if `readme=none`.
- *
- * @category fileOutput
- */
-export declare const indexFileName: DeclarationOption;
-/**
  * @category ui
@@ -98,0 +92,0 @@ */

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.titleTemplate = exports.indexPageTitle = exports.hideInPageTOC = exports.hideBreadcrumbs = exports.hidePageTitle = exports.hidePageHeader = exports.indexFileName = exports.entryFileName = exports.membersWithOwnFile = exports.mdOutputFileStrategy = void 0;
+exports.namedAnchors = exports.anchorPrefix = exports.preserveAnchorCasing = exports.indexFormat = exports.typeDeclarationFormat = exports.enumMembersFormat = exports.propertiesFormat = exports.parametersFormat = exports.expandObjects = exports.useCodeBlocks = exports.excludeGroups = exports.titleTemplate = exports.indexPageTitle = exports.hideInPageTOC = exports.hideBreadcrumbs = exports.hidePageTitle = exports.hidePageHeader = exports.entryFileName = exports.membersWithOwnFile = exports.mdOutputFileStrategy = void 0;
 const typedoc_1 = require("typedoc");
@@ -118,13 +118,2 @@ const custom_maps_1 = require("./custom-maps");
 /**
- * This option is ignored if `readme=none`.
- *
- * @category fileOutput
- */
-exports.indexFileName = {
-    name: 'indexFileName',
-    help: 'The file name the seperate index page.',
-    type: typedoc_1.ParameterType.String,
-    defaultValue: 'API.md',
-};
-/**
  * @category ui
@@ -131,0 +120,0 @@ */

dist/plugin/options/models.d.ts

@@ -6,3 +6,2 @@ declare module 'typedoc' {
         entryFileName: string;
-        indexFileName: string;
         hidePageHeader: boolean;
@@ -31,3 +30,2 @@ hidePageTitle: boolean;
     entryFileName: string;
-    indexFileName: string;
     hidePageHeader: boolean;
@@ -34,0 +32,0 @@ hidePageTitle: boolean;

dist/theme/helpers.d.ts

@@ -25,1 +25,2 @@ /**
 export declare function getSignatureParameters(parameters: ParameterReflection[], format?: boolean): string;
+export declare function getIndexFileName(project: ProjectReflection): "modules.md" | "exports.md";

dist/theme/helpers.js

@@ -9,3 +9,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSignatureParameters = exports.flattenDeclarations = exports.declarationHasParent = exports.getMemberTitle = exports.KEYWORD_MAP = exports.getModifier = exports.isGroupKind = exports.hasTOC = exports.hasIndex = exports.getProjectDisplayName = exports.getDeclarationType = void 0;
+exports.getIndexFileName = exports.getSignatureParameters = exports.flattenDeclarations = exports.declarationHasParent = exports.getMemberTitle = exports.KEYWORD_MAP = exports.getModifier = exports.isGroupKind = exports.hasTOC = exports.hasIndex = exports.getProjectDisplayName = exports.getDeclarationType = void 0;
 const typedoc_1 = require("typedoc");
@@ -196,1 +196,7 @@ const elements_1 = require("../support/elements");
 exports.getSignatureParameters = getSignatureParameters;
+function getIndexFileName(project) {
+    var _a;
+    const isModules = (_a = project.children) === null || _a === void 0 ? void 0 : _a.every((child) => child.kindOf(typedoc_1.ReflectionKind.Module));
+    return isModules ? 'modules.md' : 'exports.md';
+}
+exports.getIndexFileName = getIndexFileName;

dist/theme/resources/partials/header.js

@@ -24,3 +24,3 @@ "use strict";
     const entryFileName = context.options.getValue('entryFileName');
-    const indexFileName = context.options.getValue('indexFileName');
+    const indexFileName = (0, helpers_1.getIndexFileName)(page.project);
     const titleLink = context.options.getValue('titleLink');
@@ -27,0 +27,0 @@ const hasBreadcrumbs = !context.options.getValue('hideBreadcrumbs');

dist/theme/urls-context.js

@@ -50,3 +50,3 @@ "use strict";
         const entryFileName = this.options.entryFileName;
-        const indexFileName = this.options.indexFileName;
+        const indexFileName = (0, helpers_1.getIndexFileName)(project);
         const hasReadme = !((_a = this.options.readme) === null || _a === void 0 ? void 0 : _a.endsWith('none'));
@@ -53,0 +53,0 @@ if (hasReadme) {

package.json

 {
   "name": "typedoc-plugin-markdown",
-  "version": "4.0.0-next.21",
+  "version": "4.0.0-next.22",
   "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

@@ -11,8 +11,8 @@ # typedoc-plugin-markdown
 
-*   [What does it do?](#what-does-it-do)
-*   [Installation](#installation)
-*   [Usage](#usage)
-*   [Options](#options)
-*   [Contributing](#contributing)
-*   [License](#license)
+* [What does it do?](#what-does-it-do)
+* [Installation](#installation)
+* [Usage](#usage)
+* [Options](#options)
+* [Contributing](#contributing)
+* [License](#license)
 
@@ -55,29 +55,28 @@ ## What does it do?
 
-*   [`--outputFileStrategy`](./docs/guides/options.md#--outputfilestrategy)
-*   [`--membersWithOwnFile`](./docs/guides/options.md#--memberswithownfile)
-*   [`--entryFileName`](./docs/guides/options.md#--entryfilename)
-*   [`--indexFileName`](./docs/guides/options.md#--indexfilename)
+* [`--outputFileStrategy`](./docs/guides/options.md#--outputfilestrategy)
+* [`--membersWithOwnFile`](./docs/guides/options.md#--memberswithownfile)
+* [`--entryFileName`](./docs/guides/options.md#--entryfilename)
 
 #### Structure and formatting options
 
-*   [`--hidePageHeader`](./docs/guides/options.md#--hidepageheader)
-*   [`--hidePageTitle`](./docs/guides/options.md#--hidepagetitle)
-*   [`--hideBreadcrumbs`](./docs/guides/options.md#--hidebreadcrumbs)
-*   [`--hideInPageTOC`](./docs/guides/options.md#--hideinpagetoc)
-*   [`--indexPageTitle`](./docs/guides/options.md#--indexpagetitle)
-*   [`--titleTemplate`](./docs/guides/options.md#--titletemplate)
-*   [`--excludeGroups`](./docs/guides/options.md#--excludegroups)
-*   [`--useCodeBlocks`](./docs/guides/options.md#--usecodeblocks)
-*   [`--expandObjects`](./docs/guides/options.md#--expandobjects)
-*   [`--parametersFormat`](./docs/guides/options.md#--parametersformat)
-*   [`--propertiesFormat`](./docs/guides/options.md#--propertiesformat)
-*   [`--enumMembersFormat`](./docs/guides/options.md#--enummembersformat)
-*   [`--typeDeclarationFormat`](./docs/guides/options.md#--typedeclarationformat)
-*   [`--indexFormat`](./docs/guides/options.md#--indexformat)
+* [`--hidePageHeader`](./docs/guides/options.md#--hidepageheader)
+* [`--hidePageTitle`](./docs/guides/options.md#--hidepagetitle)
+* [`--hideBreadcrumbs`](./docs/guides/options.md#--hidebreadcrumbs)
+* [`--hideInPageTOC`](./docs/guides/options.md#--hideinpagetoc)
+* [`--indexPageTitle`](./docs/guides/options.md#--indexpagetitle)
+* [`--titleTemplate`](./docs/guides/options.md#--titletemplate)
+* [`--excludeGroups`](./docs/guides/options.md#--excludegroups)
+* [`--useCodeBlocks`](./docs/guides/options.md#--usecodeblocks)
+* [`--expandObjects`](./docs/guides/options.md#--expandobjects)
+* [`--parametersFormat`](./docs/guides/options.md#--parametersformat)
+* [`--propertiesFormat`](./docs/guides/options.md#--propertiesformat)
+* [`--enumMembersFormat`](./docs/guides/options.md#--enummembersformat)
+* [`--typeDeclarationFormat`](./docs/guides/options.md#--typedeclarationformat)
+* [`--indexFormat`](./docs/guides/options.md#--indexformat)
 
 #### Utility options
 
-*   [`--preserveAnchorCasing`](./docs/guides/options.md#--preserveanchorcasing)
-*   [`--anchorPrefix`](./docs/guides/options.md#--anchorprefix)
-*   [`--namedAnchors`](./docs/guides/options.md#--namedanchors)
+* [`--preserveAnchorCasing`](./docs/guides/options.md#--preserveanchorcasing)
+* [`--anchorPrefix`](./docs/guides/options.md#--anchorprefix)
+* [`--namedAnchors`](./docs/guides/options.md#--namedanchors)
 
@@ -84,0 +83,0 @@ ## Contributing

No alert changes

Worsened metrics

Total package byte prevSize

196778

decreased by-0.08%

Lines of code

4736

decreased by-0.25%

Number of lines in readme file

88

decreased by-1.12%

No dependency changes