Skip to content

Invalid link with backtick aren't repported #2606

Closed
@regseb

Description

@regseb

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

Activity

added this to the v0.26.1 milestone on Jun 22, 2024
added a commit that references this issue on Jun 23, 2024
e9bd40b
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    No projects

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @regseb@Gerrit0

        Issue actions

          Invalid link with backtick aren't repported · Issue #2606 · TypeStrong/typedoc