Add GitHub Alert Syntax #5
Merged
Conversation
This file contains hidden or 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
jamliaoo
commented
Nov 17, 2024
| @@ -1 +1 @@ | |||
| window.contentConfig = {"title":"Access8Math","latexDelimiter":"bracket","documentFormat":"block","documentDisplay":"markdown","sourceText":"## Question 1\n\n1. \\({{\\left( -3 \\right)}^{3}}\\)之值為何？\n(A) \\(-27\\)\n(B) \\(-9\\)\n(C) \\(9\\)\n(D) \\(27\\)\n2. aewf",documentColor: "dark"} No newline at end of file | |||
| window.contentConfig = {"title":"Access8Math","latexDelimiter":"bracket","documentFormat":"block","documentDisplay":"markdown","documentColor": "light","sourceText":"## Question 1\n\n1. \\({{\\left( -3 \\right)}^{3}}\\)之值為何？\n(A) \\(-27\\)\n(B) \\(-9\\)\n(C) \\(9\\)\n(D) \\(27\\)\n2. aewf\n ## Alert Example\n\n> [!NOTE]\n> Highlights information that users should take into account, even when skimming.\n\n> [!TIP]\n> Optional information to help a user be more successful.\n\n> [!IMPORTANT]\n> Crucial information necessary for users to succeed.\n\n> [!WARNING]\n> Critical content demanding immediate user attention due to potential risks.\n\n> [!CAUTION]\n> Negative potential consequences of an action."} No newline at end of file | |||
Contributor
Author
There was a problem hiding this comment.
- 新增 alert 的 sample 文字
- 把 sourceText 放到最後面，方便看其他 property 的值
Contributor
Author
|
WendellLiu
reviewed
Dec 2, 2024
Comment on lines
68
to
105
| if (matchedVariant) { | ||
| const { | ||
| type: variantType, | ||
| icon, | ||
| title = ucfirst(variantType), | ||
| titleClassName = `${className}-title`, | ||
| } = matchedVariant; | ||
| const typeRegexp = new RegExp(createSyntaxPattern(variantType)); | ||
|
|
||
| Object.assign(token, { | ||
| type: 'alert', | ||
| meta: { | ||
| className, | ||
| variant: variantType, | ||
| icon, | ||
| title, | ||
| titleClassName, | ||
| }, | ||
| }); | ||
|
|
||
| const firstLine = token.tokens?.[0]; | ||
| const firstLineText = firstLine.raw?.replace(typeRegexp, '').trim(); | ||
|
|
||
| if (firstLineText) { | ||
| const patternToken = firstLine.tokens[0]; | ||
|
|
||
| Object.assign(patternToken, { | ||
| raw: patternToken.raw.replace(typeRegexp, ''), | ||
| text: patternToken.text.replace(typeRegexp, ''), | ||
| }); | ||
|
|
||
| if (firstLine.tokens[1]?.type === 'br') { | ||
| firstLine.tokens.splice(1, 1); | ||
| } | ||
| } else { | ||
| token.tokens?.shift(); | ||
| } | ||
| } |
Contributor
There was a problem hiding this comment.
Could we avoid "nested if-block" and "else"?
if (!matchedVariant) return;
// some codes
if (!firstLineText) token.tokens?.shift();
// some codes
if (firstLine.tokens[1]?.type === 'br') {
firstLine.tokens.splice(1, 1);
}
Contributor
Author
There was a problem hiding this comment.
Thanks for pointing that out, it’s a great suggestion
aee4baa
WendellLiu
reviewed
Dec 20, 2024
Comment on lines
89
to
106
| const firstLine = token.tokens?.[0]; | ||
| const firstLineText = firstLine.raw?.replace(typeRegexp, '').trim(); | ||
|
|
||
| if (!firstLineText) { | ||
| token.tokens?.shift(); | ||
| return; | ||
| } | ||
|
|
||
| const patternToken = firstLine.tokens[0]; | ||
|
|
||
| Object.assign(patternToken, { | ||
| raw: patternToken.raw.replace(typeRegexp, ''), | ||
| text: patternToken.text.replace(typeRegexp, ''), | ||
| }); | ||
|
|
||
| if (firstLine.tokens[1]?.type === 'br') { | ||
| firstLine.tokens.splice(1, 1); | ||
| } |
Contributor
There was a problem hiding this comment.
I know mutating is the pattern the official demos, so it's okay to me to mutate directly on token. However, could you avoid mutating the children of token by accessing and mutating? For readability, please consider reassgin instead of deep mutation.
Contributor
Author
There was a problem hiding this comment.
I’ve updated the code to avoid deep mutations on children of token and switched to reassigning instead. I think it’s more readable now. Let me know if you have any additional suggestions!
9f63a68
WendellLiu
reviewed
Dec 20, 2024
Comment on lines
34
to
39
| return Object.values( | ||
| [...defaultAlertVariant, ...variants].reduce((map, item) => { | ||
| map[item.type] = item; | ||
| return map; | ||
| }, {}), | ||
| ); |
Contributor
There was a problem hiding this comment.
- please do not mutate the argument in a reduce.
- why do we need a
reducebut turn out we only return the values of the map from reduce? it looks like it is equivalent to[...defaultAlertVariant, ...variants]
Contributor
Author
There was a problem hiding this comment.
Thanks, the handling of this function isn’t ideal. I originally wanted to make it similar to the marked alert package by allowing external options, but looking at it now, it feels unnecessary and just adds complexity. So, I’ve removed the function for now. Let me know if you’ve got other thoughts!
ded5016
WendellLiu
approved these changes
Jan 6, 2025
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
Discussion
完整引入 tailwind css：css 2kb
只引入 utilities：css 763B
11/18 討論結論