Skip to content

Breadcrumbs are missing on project page #2728

@mrfigg

Description

@mrfigg

Not sure if I should label this as a bug or feature request, but this one feels more like a bug to me.

Search terms

breadcrumbs headings modules index

Expected Behavior

Expected page title breadcrumbs and heading to be consistent across all pages.

Actual Behavior

Breadcrumbs are missing from the modules.html index page despite being on all other index pages (modules/*.html). Also the heading is an h2 instead of an h1.

Steps to reproduce the bug

src/index.ts:

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

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

typedoc.json:

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

docs/modules.html screenshot:
example

Compared to:

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"]
}

docs/modules/index.html screenshot:
example2

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

    good first issueEasier issue for first time contributorshelp wantedContributions are especially encouraged

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions