-
Notifications
You must be signed in to change notification settings - Fork 49
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
🔗 Enable external MyST project cross-references #1180
Merged
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
choldgraf
reviewed
May 6, 2024
choldgraf
reviewed
May 6, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few quick thoughts on improving the clarity of the docs here. This is looking super cool!
Co-authored-by: Chris Holdgraf <choldgraf@berkeley.edu>
Turns out that the |
@fwkoch I have moved the outstanding task list here: |
This was referenced May 7, 2024
15 tasks
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.
This PR adds support for cross-references to external MyST projects, similar to intersphinx.
To do this, MyST projects serve a
myst.xref.json
file which contains all the available project targets. Then, when you add a reference to this project in your project config:you may add cross-reference links with the format
[](xref:key/path#identifier)
.This PR also:
xref:...
instead ofmyst:...
(old syntax generates a warning)label
to page frontmatter for specifying an identifier for the page that is not just the filename/slugname
is now an alias oflabel
on page frontmattername
is removed from project frontmatterSee also:
TODO:
{embed}
(separate PR)<xref:key>
(separate PR)<xref:key#id>
identifier
oncrossReference
, etc nodes in favour oftarget
(separate PR)myst.xref.json
- no duplicate identifier/html_id, no page slug identifiers