question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

[v2] Improve md interlinking doc / experience

See original GitHub issue

@slorber: it was initially a bug report, what we can improve is here: https://github.com/facebook/docusaurus/issues/2851#issuecomment-642654109


🐛 Bug Report

Different behavior between ‘.mdx’ and ‘.md’ extensions in markdown link.

  • [Button](./docs/Button.md)
  • [Button](./docs/Button.mdx)

Have you read the Contributing Guidelines on issues?

yes

To Reproduce

  1. In README.md [Button](./docs/Button.mdx)
  2. docusaurus start
  3. Click Button link.

Expected behavior

Navigate to docs/button same as [Button](./docs/Button.md)

Actual Behavior

It will open a download dialog in chrome 83.

Your Environment

  • Docusaurus version used: 2.0.0-alpha.56
  • Environment name and version : Chrome 83, Node.js 14
  • Operating system and version : desktop

Reproducible Demo

(Paste the link to an example repo, including a siteConfig.js, and exact instructions to reproduce the issue.)

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:18

github_iconTop GitHub Comments

1reaction
slorbercommented, Jun 15, 2020

@krillboi when you use <Link/> you provide a path, not a file. Behind, it’s just regular ReactRouter Link, there’s no additional logic.

This path may be created in various ways, not necessarily related to MD files, including using the pages, the addRoute api: https://v2.docusaurus.io/docs/lifecycle-apis/#actions

We resolve MD doc links to their appropriate versioned paths, as a convenient thing for the user to build versioned docs, but we don’t currently do that for link components.

We could make it work, but it’s a whole new feature to design and work on

1reaction
cncoldercommented, Jun 11, 2020

@slorber yes. But now I have resolve file path. My docs folder like this:

tree tarojsx.github.io/docs

docs
├── hooks
│   ├── README.md
│   └── docs
│       └── useLogger.mdx
└── ui
    ├── README.md
    └── docs
        └── components
            └── List.mdx

https://github.com/tarojsx/tarojsx.github.io/tree/docusaurus/docs

Read more comments on GitHub >

github_iconTop Results From Across the Web

Enhancing healthcare efficiency to achieve the Quadruple Aim
This quasi-experimental pilot study tested a 2 week intervention aimed to address the Quadruple Aims while improving productivity. Participants ...
Read more >
National Guidelines for Behavioral Health Crisis Care
The National Guidelines for Crisis Care – A Best Practice Toolkit advances national guidelines in crisis care within a toolkit that supports ...
Read more >
Maryland Interconnection - FirstEnergy
Below are steps to help guide you through the Interconnection Process. ... Step 2 - Type of Application Based on Capacity Level.
Read more >
News - Improve Outcomes and Enhance the Patient Experience
CRISP is seeking a vendor(s) to evaluate specific aspects of the Maryland Total Cost of Care (TCOC) model and care transformation efforts throughout...
Read more >
A systematic review of evidence on the links between patient ...
What aspects of patient experience can be linked to clinical ... It is also justified on more utilitarian grounds as a means of...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found