Use MDX to add proper image captions in web and pdf documentation #1914
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
github-actions
bot
added
the
needs label triage
Codecov Report
@@ Coverage Diff @@
## main #1914 +/- ##
==========================================
- Coverage 58.13% 58.12% -0.01%
==========================================
Files 461 461
Lines 21488 21488
Branches 5102 5102
==========================================
- Hits 12492 12490 -2
- Misses 8685 8687 +2
Partials 311 311
Continue to review full report at Codecov.
|
cmdcolin
added
documentation
and removed
needs label triage
Use acorn parser to parse the jsx tag for figure
cmdcolin
force-pushed
the
fix_captions_mdx
branch
from
abb8408 to
b64a16b
Compare
cmdcolin
changed the title
|
I think this one is pretty solid...maybe I'll just go ahead and merge. Can revisit if needed |
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 is a stub PR that tries to standardize how to make captions on figures in our docs
Currently it is assumed the line following a markdown image like
is a caption, and this is actually hardcoded as an assumption in the PDF. There is also the suggestion to fill out alt text e.g.Currently the webpages don't even display captions that well, and since markdown has no real good concept of a caption, I propose using MDX for this
This PR begins this propagation
It appears to work well on the user guide and quickstart_gui for admin server, so I may continue to propagate it. Images will be moved from website/docs/img to website/static/img since I think it is required to be in static resources for use with mdx maybe https://docusaurus.io/docs/static-assets