Don't replace static assets linking in fenced code blocks #864
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Deploy preview for docusaurus-preview ready! Built with commit a040545 |
endiliey
added
the
status: don't merge yet
endiliey
removed
the
status: don't merge yet
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Fix #861 and #857 (comment)
In our code, we replace all occurences of
](assets/to]({baseUrl}/docs/assets/https://github.com/facebook/Docusaurus/blob/22f3a85a494ddf46bc29964a7989335a7dba4a9a/lib/server/docs.js#L79-L83
However, this cause a side effect to our documentation.
What we really mean
We want to tell people that they can link their assets by doing something like
Reference:
https://github.com/facebook/Docusaurus/blob/master/docs/api-doc-markdown.md
Misleading Documentation
However, the
is replaced intohttps://docusaurus.io/docs/en/next/doc-markdown#linking-to-images-and-other-assets
Solution: We should only replace static assets linking if it is not inside a fenced block
Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan