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

Doesn't find anchor in README.md #2604

Closed
regseb opened this issue Jun 22, 2024 · 1 comment
Closed

Doesn't find anchor in README.md #2604

regseb opened this issue Jun 22, 2024 · 1 comment
Labels
bug Functionality does not match expectation
Milestone

Comments

@regseb
Copy link

regseb commented Jun 22, 2024

Search terms

relative, path, anchor, markdown, README

Expected Behavior

TypeDoc shouldn't report any problems for links in the README.md to a header also in the README.md.

Actual Behavior

TypeDoc report: The relative path #foo does not exist

Steps to reproduce the bug

package.json

{
  "name": "testcase",
  "version": "1.0.0",
  "dependencies": {
    "typedoc": "0.26.0",
    "typescript": "5.5.2"
  }
}

README.md

[foo](#foo)

## foo

Bar.

tsconfig.json

{
  "typedocOptions": {
    "entryPoints": ["index.ts"]
  }
}

index.ts

// Unimportant.

Steps

  1. npm install

  2. npx typedoc

    ./README.md:1:6 - [warning] The relative path #foo does not exist
    
    1    [foo](#foo)
    
    [info] Documentation generated at ./docs
    [warning] Found 0 errors and 1 warnings
    

Environment

  • Typedoc version: 0.26.0
  • TypeScript version: 5.5.2
  • Node.js version: 20.14.0
  • OS: Ubuntu 22.04.4 LTS
@regseb regseb added the bug Functionality does not match expectation label Jun 22, 2024
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jun 22, 2024

Ah, yeah that's a problem... I forgot about anchor links when looking for relative links.

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
Projects
None yet
Development

No branches or pull requests

2 participants