Skip to content

Markdown links do not resolve properly with file names containing spaces #3006

@nicfv

Description

@nicfv

Search terms

markdown, links, documentation, projectDocumentation, readme

Actual Behavior

When using [markdown](./links) it doesn't resolve like it should. It actually generates that .md page in the docs folder and links to that instead of the generated HTML page.

Expected Behavior

The link should resolve to the generated HTML page instead.

Could I be missing a configuration option?

Steps to reproduce the bug

mkdir md_links_issue
cd md_links_issue
npm init -y
npm i -y typedoc
mkdir -p src/docs
echo '[Link](./docs/Two%20Words.md)' > src/README.md
echo '[Back](../README.md)' > 'src/docs/Two Words.md'
echo '
{
    "readme": "./src/README.md",
    "projectDocuments": [
        "./src/docs/*.md",
    ],
}
' > typedoc.json
npx typedoc
open docs/index.html

Click on the links to test.

Environment

  • Typedoc version: 0.28.11
  • TypeScript version: 5.9.2
  • Node.js version: v20.17.0
  • OS: Ubuntu 24.04

Media

Image The index page

Image Clicking on "link"

Image Clicking on "Two Words" in the navigation bar

Image Clicking on "Back"

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