Add md attribute to set image width#123
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
22e86fe to
50d21ed
Compare
|
@markotoplak is attempting to deploy a commit to the biolab Team on Vercel. A member of the Team first needs to authorize it. |
3d49484 to
ba58ae6
Compare
Member
|
Janez, thanks for the PR you probably forgot about. :) |
This file contains hidden or 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
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 allows to set the width for images in documentation for widgets, e.g.
or
This syntax is used because it is supported by myst, which we use as a sphinx plugin for building the docs.
A regex is used to replace the above with
<!--rehype:width="300"-->, which is a syntax handled by the rehype-attr plugin. I would prefer using remark-attr that supports myst's syntax directly, but remark-attr hasn't been touched since 2020 and no longer works. An alternative would be to reimplement remart-attr on our own ... but this approach is simpler.Furthermore, the PR modifies
getImageDatato respect the manually set width (and scale the height correspondingly).