feat(gatsby-remark-images): Add markdownCaptions option #16574
Merged
+177
−27
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
|
I do wonder if there are any instances where user wouldn't want to parse captions as markdown (i.e. if we can get away without adding extra config option, and just parse it every time)? Question of backward compat here - if raw text (without any markdown formatting) using parsing and generation produces same thing as before? ---edit I guess parsing+generation do add wrapping |
|
Indeed, for backward compatibility we need a new option. |
sidharthachatterjee
approved these changes
Aug 13, 2019
sidharthachatterjee
changed the title
pieh
reviewed
Aug 13, 2019
|
Hey @mathieudutour that's a super useful feature 👏 |
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.
Description
This PR adds an option to parse image captions as markdown. To do so, the gatsby remark plugin needs access to the "compiler", eg. parsing a markdown string and generating an html string from it.
So the PR also contains a change to
gatsby-remark-transformerto pass that down to plugins.Related Issues
Fixes #14474
Caveat
gatsby-plugin-mdxdoesn't pass down the compiler yet, so the option is going to be ignored when used with the mdx plugin. This will be address in a follow-up PR because there isn't any great way to it yet.