Skip to content

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

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

Closed
mrfigg opened this issue Oct 6, 2024 · 0 comments
Closed

Comments

@mrfigg
Copy link
Contributor

mrfigg commented Oct 6, 2024

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
@mrfigg mrfigg added the bug label Oct 6, 2024
@Gerrit0 Gerrit0 added needs reproduction Needs a minimal reproducible case - https://gist.github.com/Rich-Harris/88c5fc2ac6dc941b22e7996af05d no bug This is expected behavior and removed needs reproduction Needs a minimal reproducible case - https://gist.github.com/Rich-Harris/88c5fc2ac6dc941b22e7996af05d no bug This is expected behavior labels Oct 6, 2024
@Gerrit0 Gerrit0 closed this as completed in 7cb5f50 Oct 6, 2024
@Gerrit0 Gerrit0 removed the bug label Feb 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants