Skip to content

Doesn't find anchor in README.md #2604

@regseb

Description

@regseb

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions