Add syntax highlighting for LiquidDoc @description tag
#30
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
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.
Closes: https://github.com/Shopify/developer-tools-team/issues/560
What is this PR doing?
Adding syntax highlighting for the
@descriptiontag.I also made a change to the way we highlight
@tags.Originally, so long as you started with
@, we would highlight what followed as if it were a proper tag. The problem is it could confuse people into assuming they are valid tags and currently we only handle@param,@example, and@descriptionThe change makes anything other than those tags highlight as commented code. The only time we will highlight proper tags is once they are complete.
Example:
I'm open for discussion if anyone has thoughts about this implementation.