🔗 Add support for myst.xref.json #372
Merged
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
fwkoch
commented
May 4, 2024
| @@ -14,7 +14,17 @@ function api404(message = 'No API route found at this URL') { | |||
|
|
|||
| export const loader: LoaderFunction = async ({ request, params }) => { | |||
| const { slug } = params; | |||
| // Handle /myst.xref.json as slug | |||
| if (slug === 'myst.xref') { | |||
There was a problem hiding this comment.
It would be much nicer if we could have a separate loader in a different file [myst.xref.json].tsx. However, that URL gets gobbled up by this file, where $slug is resolved to myst.xref...
fwkoch
commented
May 4, 2024
| return json(data); | ||
| return json(data, { | ||
| headers: { | ||
| 'Access-Control-Allow-Origin': '*', |
There was a problem hiding this comment.
This covers the basic case of loading cross-reference tool-tips from external sites. It won't work for github pages.
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.
Cross references for external MyST projects is added here: jupyter-book/mystmd#1180 - this PR finesses the themes so those changes work well:
myst.xref.jsonis served by the theme, similar toobjects.inv/api/lookupis no longer used for external links