Skip to content

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

@tomfrenken

Description

@tomfrenken

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)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions