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

@links not working in monorepo readmes #2029

Closed
WHenderson opened this issue Aug 11, 2022 · 1 comment
Closed

@links not working in monorepo readmes #2029

WHenderson opened this issue Aug 11, 2022 · 1 comment
Labels
bug Functionality does not match expectation good first issue Easier issue for first time contributors

Comments

@WHenderson
Copy link

Expected Behavior

Links inside monorepo readme files should resolve to typedoc links.

e.g.

/packages/repo/README.md

link to my function: {@link my_function}

Should generate page content similar to:

link to my function: <a href=".../functions/_my_repo.my_function.html">my_function</a>

Actual Behavior

Omits the anchor tag, resulting in plain text with no link such as

link to my function: my_function

Steps to reproduce the bug

  1. Create a mono-repo with a configured readme
  2. Add a {@link my_function} to the readme, replacing my_function with a symbol name from your repo
  3. Run typedoc and examine the output

Environment

  • Typedoc version: 0.23.10
  • TypeScript version: 4.7.4
  • Node.js version: 16.13.2
  • OS: Windows
@WHenderson WHenderson added the bug Functionality does not match expectation label Aug 11, 2022
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Aug 11, 2022

Oops, introduced with 3830f96. The LinkResolverPlugin no longer checks reflection.readme.

@Gerrit0 Gerrit0 added the good first issue Easier issue for first time contributors label Aug 11, 2022
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 good first issue Easier issue for first time contributors
Projects
None yet
Development

No branches or pull requests

2 participants