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

Invalid link with backtick aren't repported #2606

Closed
regseb opened this issue Jun 22, 2024 · 0 comments
Closed

Invalid link with backtick aren't repported #2606

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

Comments

@regseb
Copy link

regseb commented Jun 22, 2024

Search terms

relative, path, anchor, markdown, README, link, backtick

Expected Behavior

Links in README.md that have the wrong path must be reported, even if they have backticks in their text.

Actual Behavior

Invalid links with backticks in the text aren't reported.

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)

tsconfig.json

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

index.ts

// Unimportant.

Steps

  1. npm install

  2. npx typedoc

    [info] Documentation generated at ./docs
    

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 Gerrit0 added this to the v0.26.1 milestone Jun 22, 2024
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