-
Notifications
You must be signed in to change notification settings - Fork 94
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
Use an <img> for SVG output instead of an <object> #131
Open
tsibley
wants to merge
1
commit into
mgaitan:master
Choose a base branch
from
tsibley:svg-as-img
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
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
<img>, unlike <object>, has proper alt text support (i.e. that's not just fallback content) and is easily saved, opened in a new tab, etc. from the page where it appears. This does mean the SVG's DOM will no longer be available for inspection by JavaScript in the containing document (e.g. object.contentDocument), but I don't think that was intended to be a feature of SVG output for this Sphinx extension. Resolves <mgaitan#102> as well.
tsibley
added a commit
to nextstrain/cli
that referenced
this pull request
Nov 21, 2023
Mermaid.js¹ supports a number of useful diagrams types that are otherwise difficult to create programmatically. The addition now is motivated by wanting to add some sequence diagrams for new authn documentation. The Sphinx/Mermaid integration, sphinxcontrib-mermaid, defaults to client-side rendering at page load time, but this comes with some downsides and practically no upsides. Configure it to render at doc build time instead. Related to this change, I submitted two patches upstream to the Sphinx integration which I think improve the build-time render results: a patch to remove unnecessary JS from the page by default² and a patch to display the SVGs as images rather than embedded documents.³ ¹ <https://mermaid.js.org> ² <mgaitan/sphinxcontrib-mermaid#132> ³ <mgaitan/sphinxcontrib-mermaid#131>
tsibley
added a commit
to nextstrain/cli
that referenced
this pull request
Nov 21, 2023
Mermaid.js¹ supports a number of useful diagrams types that are otherwise difficult to create programmatically. The addition now is motivated by wanting to add some sequence diagrams for new authn documentation. The Sphinx/Mermaid integration, sphinxcontrib-mermaid, defaults to client-side rendering at page load time, but this comes with some downsides and practically no upsides. Configure it to render at doc build time instead. Related to this change, I submitted two patches upstream to the Sphinx integration which I think improve the build-time render results: a patch to remove unnecessary JS from the page by default² and a patch to display the SVGs as images rather than embedded documents.³ ¹ <https://mermaid.js.org> ² <mgaitan/sphinxcontrib-mermaid#132> ³ <mgaitan/sphinxcontrib-mermaid#131>
tsibley
added a commit
to nextstrain/cli
that referenced
this pull request
Nov 21, 2023
Mermaid.js¹ supports a number of useful diagrams types that are otherwise difficult to create programmatically. The addition now is motivated by wanting to add some sequence diagrams for new authn documentation. The Sphinx/Mermaid integration, sphinxcontrib-mermaid, defaults to client-side rendering at page load time, but this comes with some downsides and practically no upsides. Configure it to render at doc build time instead. Related to this change, I submitted two patches upstream to the Sphinx integration which I think improve the build-time render results: a patch to remove unnecessary JS from the page by default² and a patch to display the SVGs as images rather than embedded documents.³ ¹ <https://mermaid.js.org> ² <mgaitan/sphinxcontrib-mermaid#132> ³ <mgaitan/sphinxcontrib-mermaid#131>
tsibley
added a commit
to nextstrain/cli
that referenced
this pull request
Nov 22, 2023
Mermaid.js¹ supports a number of useful diagrams types that are otherwise difficult to create programmatically. The addition now is motivated by wanting to add some sequence diagrams for new authn documentation. The Sphinx/Mermaid integration, sphinxcontrib-mermaid, defaults to client-side rendering at page load time, but this comes with some downsides and practically no upsides. Configure it to render at doc build time instead. Related to this change, I submitted two patches upstream to the Sphinx integration which I think improve the build-time render results: a patch to remove unnecessary JS from the page by default² and a patch to display the SVGs as images rather than embedded documents.³ ¹ <https://mermaid.js.org> ² <mgaitan/sphinxcontrib-mermaid#132> ³ <mgaitan/sphinxcontrib-mermaid#131>
tsibley
added a commit
to nextstrain/cli
that referenced
this pull request
Nov 22, 2023
Mermaid.js¹ supports a number of useful diagrams types that are otherwise difficult to create programmatically. The addition now is motivated by wanting to add some sequence diagrams for new authn documentation. The Sphinx/Mermaid integration, sphinxcontrib-mermaid, defaults to client-side rendering at page load time, but this comes with some downsides and practically no upsides. Configure it to render at doc build time instead. Related to this change, I submitted two patches upstream to the Sphinx integration which I think improve the build-time render results: a patch to remove unnecessary JS from the page by default² and a patch to display the SVGs as images rather than embedded documents.³ ¹ <https://mermaid.js.org> ² <mgaitan/sphinxcontrib-mermaid#132> ³ <mgaitan/sphinxcontrib-mermaid#131>
tsibley
added a commit
to nextstrain/cli
that referenced
this pull request
Jan 13, 2024
Mermaid.js¹ supports a number of useful diagrams types that are otherwise difficult to create programmatically. The addition now is motivated by wanting to add some sequence diagrams for new authn documentation. The Sphinx/Mermaid integration, sphinxcontrib-mermaid, defaults to client-side rendering at page load time, but this comes with some downsides and practically no upsides. Configure it to render at doc build time instead. Related to this change, I submitted two patches upstream to the Sphinx integration which I think improve the build-time render results: a patch to remove unnecessary JS from the page by default² and a patch to display the SVGs as images rather than embedded documents.³ ¹ <https://mermaid.js.org> ² <mgaitan/sphinxcontrib-mermaid#132> ³ <mgaitan/sphinxcontrib-mermaid#131>
tsibley
added a commit
to nextstrain/cli
that referenced
this pull request
Jan 18, 2024
Mermaid.js¹ supports a number of useful diagrams types that are otherwise difficult to create programmatically. The addition now is motivated by wanting to add some sequence diagrams for new authn documentation. The Sphinx/Mermaid integration, sphinxcontrib-mermaid, defaults to client-side rendering at page load time, but this comes with some downsides and practically no upsides. Configure it to render at doc build time instead. Related to this change, I submitted two patches upstream to the Sphinx integration which I think improve the build-time render results: a patch to remove unnecessary JS from the page by default² and a patch to display the SVGs as images rather than embedded documents.³ ¹ <https://mermaid.js.org> ² <mgaitan/sphinxcontrib-mermaid#132> ³ <mgaitan/sphinxcontrib-mermaid#131>
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.
<img>
, unlike<object>
, has proper alt text support (i.e. that's not just fallback content) and is easily saved, opened in a new tab, etc. from the page where it appears.This does mean the SVG's DOM will no longer be available for inspection by JavaScript in the containing document (e.g.
object.contentDocument
), but I don't think that was intended to be a feature of SVG output for this Sphinx extension.Resolves #102 as well.