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

Spaces are no longer valid in links #9935

Closed
2 of 7 tasks
Sainan opened this issue Mar 9, 2024 · 4 comments
Closed
2 of 7 tasks

Spaces are no longer valid in links #9935

Sainan opened this issue Mar 9, 2024 · 4 comments
Labels
bug An error in the Docusaurus core causing instability or issues with its execution closed: working as intended This issue is intended behavior, there's no need to take any action. domain: markdown Related to Markdown parsing or syntax

Comments

@Sainan
Copy link
Contributor

Sainan commented Mar 9, 2024

Have you read the Contributing Guidelines on issues?

Prerequisites

  • I'm using the latest version of Docusaurus.
  • I have tried the npm run clear or yarn clear command.
  • I have tried rm -rf node_modules yarn.lock package-lock.json and re-installing packages.
  • I have tried creating a repro with https://new.docusaurus.io.
  • I have read the console error message carefully (if applicable).

Description

We recently upgraded from Docusaurus 2 to 3.1.1 and this is one of our links that broke: [constexpr attribute](Constexpr Attribute.md)

It seems the space within the parentheses is no longer valid now. However, it is valid when I either use %20 or angle brackets: (<Constexpr Attribute.md>)

This doesn't seem to be documented as an intentional breaking change from 3, so probably an unintentional break?

Reproducible demo

No response

Steps to reproduce

  1. Create two markdown files, one with a space in the name.
  2. Try to link the markdown file with the space in the name.

Expected behavior

It would make a link.

Actual behavior

The markdown link is not interpreted, instead dumped into the build as plain text.

Your environment

  • Docusaurus version used: 3.1.1

Self-service

  • I'd be willing to fix this bug myself.
@Sainan Sainan added bug An error in the Docusaurus core causing instability or issues with its execution status: needs triage This issue has not been triaged by maintainers labels Mar 9, 2024
@Josh-Cena
Copy link
Collaborator

Your original syntax was not a valid Markdown link. You can try here: https://mdxjs.com/playground/

image

It was a bug that Docusaurus mapped it to a valid Markdown link.

@Josh-Cena Josh-Cena closed this as not planned Won't fix, can't repro, duplicate, stale Mar 9, 2024
@Josh-Cena Josh-Cena added closed: working as intended This issue is intended behavior, there's no need to take any action. domain: markdown Related to Markdown parsing or syntax and removed status: needs triage This issue has not been triaged by maintainers labels Mar 9, 2024
@Sainan
Copy link
Contributor Author

Sainan commented Mar 9, 2024

Fair on not being valid Markdown. Still an undocumented breaking change. 😕

@slorber
Copy link
Collaborator

slorber commented Mar 9, 2024

A bugfix is not a breaking change

You have to read the full Changelog to read about bugfixes, documenting all of them would be overwhelming.

@Sainan
Copy link
Contributor Author

Sainan commented Mar 9, 2024

It is when it was a bug people were relying on.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug An error in the Docusaurus core causing instability or issues with its execution closed: working as intended This issue is intended behavior, there's no need to take any action. domain: markdown Related to Markdown parsing or syntax
Projects
None yet
Development

No branches or pull requests

3 participants