Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Breadcrumbs are missing on project page #2728

Closed
mrfigg opened this issue Oct 6, 2024 · 1 comment · Fixed by #2732
Closed

Breadcrumbs are missing on project page #2728

mrfigg opened this issue Oct 6, 2024 · 1 comment · Fixed by #2732
Labels
bug Functionality does not match expectation good first issue Easier issue for first time contributors help wanted Contributions are especially encouraged

Comments

@mrfigg
Copy link
Contributor

mrfigg commented Oct 6, 2024

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
@mrfigg mrfigg added the bug Functionality does not match expectation label Oct 6, 2024
@Gerrit0 Gerrit0 changed the title Page title on modules.html index page is inconsistent with page titles on other index pages (modules/*.html) Breadcrumbs are missing on project page Oct 6, 2024
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Oct 6, 2024

Easy enough to change:

{!!props.model.parent && <ul class="tsd-breadcrumb">{context.breadcrumb(props.model)}</ul>}

@Gerrit0 Gerrit0 added help wanted Contributions are especially encouraged good first issue Easier issue for first time contributors labels Oct 6, 2024
mrfigg added a commit to mrfigg/typedoc that referenced this issue Oct 6, 2024
Gerrit0 added a commit that referenced this issue Oct 8, 2024
Fixed missing breadcrumbs on project page, #2728
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Functionality does not match expectation good first issue Easier issue for first time contributors help wanted Contributions are especially encouraged
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants