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

False positive markdown link couldn't be resolved #8632

Closed
2 of 7 tasks
tisonkun opened this issue Feb 4, 2023 · 1 comment
Closed
2 of 7 tasks

False positive markdown link couldn't be resolved #8632

tisonkun opened this issue Feb 4, 2023 · 1 comment
Labels
bug An error in the Docusaurus core causing instability or issues with its execution closed: duplicate This issue or pull request already exists in another issue or pull request domain: markdown Related to Markdown parsing or syntax

Comments

@tisonkun
Copy link

tisonkun commented Feb 4, 2023

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

Markdown links in code block are not effective links, but the detector complains.

Reproducible demo

No response

Steps to reproduce

git clone https://github.com/apache/pulsar-site.git
cd pulsar-site
yarn install
./preview.sh 2.11.x

Expected behavior

Markdown links in code block should not be checked.

Actual behavior

[WARNING] Docs markdown link couldn't be resolved: (function-overview.md) in "/home/tison/Brittani/pulsar-site/contribute/document-syntax.md" for version current
[WARNING] Docs markdown link couldn't be resolved: (../../function-overview.md) in "/home/tison/Brittani/pulsar-site/contribute/document-syntax.md" for version current

Your environment

  • Public source code:

https://github.com/apache/pulsar-site/blob/38ca8e2457c3b154f2687e97c57a6c7f4f7e28e0/contribute/document-syntax.md?plain=1#L254-L257

Self-service

  • I'd be willing to fix this bug myself.
@tisonkun tisonkun 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 Feb 4, 2023
@Josh-Cena
Copy link
Collaborator

It's a known issue that the Markdown link resolver disregards any Markdown syntax, and it's a particularly hard issue to fix. The priority is low as well, because the only use case we can envision is meta-docs about how to author Markdown, as is the case here. We'll track this in #5659. For now, you can simply ignore the warning.

(BTW, the syntax does not work—you can't use backticks in JSX. You have to use all JSX syntax, like <li><code>foo</code></li>.)

@Josh-Cena Josh-Cena closed this as not planned Won't fix, can't repro, duplicate, stale Feb 4, 2023
@Josh-Cena Josh-Cena added domain: markdown Related to Markdown parsing or syntax closed: duplicate This issue or pull request already exists in another issue or pull request and removed status: needs triage This issue has not been triaged by maintainers labels Feb 4, 2023
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: duplicate This issue or pull request already exists in another issue or pull request domain: markdown Related to Markdown parsing or syntax
Projects
None yet
Development

No branches or pull requests

2 participants