search

stellar / stellar-docs

Documentation for Stellar
https://developers.stellar.org
Apache License 2.0
67 stars 128 forks source link

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

Open ElliotFriend opened 7 months ago

ElliotFriend commented 7 months ago

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 commented 1 month ago

👍🏻 incorporated as discussed and will be in final version[^m]

[^m]: From my end, at least.