Add parsing and prettier support for @example tags in liquid doc #725
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.
What are you adding in this PR?
References: https://github.com/Shopify/develop-advanced-edits/issues/471
Added support for parsing and formatting
@example
tags withinLiquidDoc
blocks.Feedback
Right now, we aren't controlling whitespace for example tags. If someone wants to write
check out. my great example
, it would stay in that format. Should trim whitespace or allow people writing examples to have full control?What's next? Any followup issues?
I want to add prettier support to automatically move
@example
tags and content below@param
as it is the proper flow.What did you learn?
AST's and CST's are quite puzzle to figure out.
Test
Example.tag.prettier.support.mp4
Before you deploy
changeset