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

bug: [[include:README.md]] syntax breaks with 0.23.X #1986

Closed
tomfrenken opened this issue Jul 7, 2022 · 2 comments
Closed

bug: [[include:README.md]] syntax breaks with 0.23.X #1986

tomfrenken opened this issue Jul 7, 2022 · 2 comments
Labels
bug Functionality does not match expectation

Comments

@tomfrenken
Copy link

Search terms

typedoc 0.23.5 [[include]]

Expected Behavior

After moving to typedoc version 0.23.5 (from 0.22.X) our links to README files broke, e.g. this pattern:

[[include:http-client/README.md]]

According to the docs this is still supported, therefore I would expect no new warnings.

Actual Behavior

Currently we receive this warning:

warning http-client/src: Comment [[target]] style links are deprecated and will be removed in 0.24
warning Failed to find target: include:http-client/README.md

Steps to reproduce the bug

Use a [[include:http-client/README.md]] like link.

Environment

  • Typedoc version: 0.23.5
  • TypeScript version: 4.7.4
  • Node.js version: 14.17.0
  • OS: macOS (latest)
@tomfrenken tomfrenken added the bug Functionality does not match expectation label Jul 7, 2022
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jul 7, 2022

Shoot, I didn't realize this would break when changing link resolution to happen earlier... should be a relatively easy fix.

@tomfrenken
Copy link
Author

Glad it's easy to fix, looking forward to trying the new version out 👍

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