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

The repo's README file should contain information on how to use markdown links #453

Closed
ElliotFriend opened this issue Apr 11, 2024 · 2 comments

Comments

@ElliotFriend
Copy link
Contributor

Docusaurus provides an opinionated suggestion for referencing other markdown files as a link: use ../link/to/file.mdx instead of ../link/to/file (for example).

The issue is that this is only possible when the two markdown files are using the same plugin. Our site is (currently) bifurcated into two instances of the plugin-content-docs plugin:

  1. everything under the /docs directory, and
  2. everything under the /network directory.

When "crossing the barrier" from one plugin to the other, we cannot use the .mdx file extension, while links within the same plugin should use the .mdx file extension.

This information should be present in the README file, or contribution guidelines, or somewhere.

@JFWooten4
Copy link
Contributor

JFWooten4 commented Oct 15, 2024

👍🏻 incorporated as discussed and will be in final version1

Footnotes

  1. From my end, at least.

@briwylde08 briwylde08 removed their assignment Jan 7, 2025
@github-project-automation github-project-automation bot moved this from To Do to Done in Dev Docs Jan 7, 2025
@briwylde08
Copy link
Contributor

Closed this one as it's being addressed in the PR!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

No branches or pull requests

5 participants
@ElliotFriend @JFWooten4 @Julian-dev28 @briwylde08 and others