Skip to content

The modules.html index page is missing when using the projectDocuments option #2730

@mrfigg

Description

@mrfigg

Search terms

projectDocuments index missing

Expected Behavior

When using the projectDocuments option the modules.html index page should exist with links to the project document pages.

Actual Behavior

The modules.html index page is missing when using the projectDocuments option.

Steps to reproduce the bug

src/index.ts:

/**
 * @packageDocumentation
 * Example
 *
 * @document ../CHANGELOG.md
 * @document ../LICENSE.md
 */

/** @private */
export function helloWorld() {
  return "Hello World";
}

typedoc.json:

{
  "entryPoints": ["./src/index.ts"],
  "out": "./docs",
  "projectDocuments": ["./README.md"]
}

Environment

  • Typedoc version: 0.26.8
  • TypeScript version: 5.6.2
  • Node.js version: 20.11.1
  • OS: Windows 10

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions