diff --git a/core/README.md b/core/README.md index c052b8d7..011e1a8f 100644 --- a/core/README.md +++ b/core/README.md @@ -617,9 +617,6 @@ import React from 'react'; import MarkdownPreview from '@uiw/react-markdown-preview'; const source = `> -> -> Useful information that users should know, even when skimming content. - > > [!NOTE] > Useful information that users should know, even when skimming content. diff --git a/core/package.json b/core/package.json index 5a162a23..885a99e7 100644 --- a/core/package.json +++ b/core/package.json @@ -66,7 +66,7 @@ "rehype-rewrite": "~4.0.0", "rehype-slug": "~6.0.0", "remark-gfm": "~4.0.0", - "remark-github-beta-blockquote-admonitions": "^3.1.1", + "remark-github-blockquote-alert": "^1.0.0", "unist-util-visit": "^5.0.0" } } diff --git a/core/src/plugins/remarkAlert.ts b/core/src/plugins/remarkAlert.ts deleted file mode 100644 index ab64b87b..00000000 --- a/core/src/plugins/remarkAlert.ts +++ /dev/null @@ -1,109 +0,0 @@ -import { visit } from 'unist-util-visit'; -import type { Plugin } from 'unified'; -import type { Root, Element, ElementContent } from 'hast'; - -const alertRegex = /^\[!(NOTE|TIP|IMPORTANT|WARNING|CAUTION)]/i; - -/** - * Alerts are a Markdown extension based on the blockquote syntax that you can use to emphasize critical information. - * On GitHub, they are displayed with distinctive colors and icons to indicate the significance of the content. - * https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts - */ -export const remarkAlert: Plugin<[], Root> = () => { - return (tree) => { - visit(tree, 'element', (node: Element, index, parent) => { - if (node.type === 'element' && node.tagName === 'blockquote') { - let isNext = true; - let alertNode = ''; - let children = [...node.children].map((item) => { - if (isNext && item.type == 'element' && item.tagName == 'p') { - const firstNode = item.children[0]; - const text = firstNode.type === 'text' ? firstNode.value : ''; - const match = text.match(alertRegex); - if (match) { - isNext = false; - alertNode = match[1].toLocaleLowerCase(); - if (text.includes('\n')) { - item.children[0] = { - type: 'text', - value: text.replace(alertRegex, '').replace(/^\n+/, ''), - }; - } - if (!text.includes('\n')) { - const itemChild: ElementContent[] = []; - item.children.forEach((item, idx) => { - if (idx == 0) return; - if (idx == 1 && item.type === 'element' && item.tagName === 'br') { - return; - } - itemChild.push(item); - }); - item.children = [...itemChild]; - } - } - } - return item; - }); - node.children = [...children]; - if (!!alertNode) { - node.tagName = 'div'; - node.properties.className = ['markdown-alert', `markdown-alert-${alertNode}`]; - const title: Element = { - type: 'element', - tagName: 'p', - properties: { - className: ['markdown-alert-title'], - dir: 'auto', - }, - children: [ - { - type: 'text', - value: alertNode.toLocaleUpperCase(), - }, - ], - }; - title.children.unshift(alertIcon(alertNode as IconType)); - node.children.unshift(title); - } - } - }); - }; -}; - -type IconType = 'note' | 'tip' | 'important' | 'warning' | 'caution'; - -let pathData: Record = { - note: 'M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z', - tip: 'M8 1.5c-2.363 0-4 1.69-4 3.75 0 .984.424 1.625.984 2.304l.214.253c.223.264.47.556.673.848.284.411.537.896.621 1.49a.75.75 0 0 1-1.484.211c-.04-.282-.163-.547-.37-.847a8.456 8.456 0 0 0-.542-.68c-.084-.1-.173-.205-.268-.32C3.201 7.75 2.5 6.766 2.5 5.25 2.5 2.31 4.863 0 8 0s5.5 2.31 5.5 5.25c0 1.516-.701 2.5-1.328 3.259-.095.115-.184.22-.268.319-.207.245-.383.453-.541.681-.208.3-.33.565-.37.847a.751.751 0 0 1-1.485-.212c.084-.593.337-1.078.621-1.489.203-.292.45-.584.673-.848.075-.088.147-.173.213-.253.561-.679.985-1.32.985-2.304 0-2.06-1.637-3.75-4-3.75ZM5.75 12h4.5a.75.75 0 0 1 0 1.5h-4.5a.75.75 0 0 1 0-1.5ZM6 15.25a.75.75 0 0 1 .75-.75h2.5a.75.75 0 0 1 0 1.5h-2.5a.75.75 0 0 1-.75-.75Z', - important: - 'M0 1.75C0 .784.784 0 1.75 0h12.5C15.216 0 16 .784 16 1.75v9.5A1.75 1.75 0 0 1 14.25 13H8.06l-2.573 2.573A1.458 1.458 0 0 1 3 14.543V13H1.75A1.75 1.75 0 0 1 0 11.25Zm1.75-.25a.25.25 0 0 0-.25.25v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25Zm7 2.25v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 9a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z', - warning: - 'M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z', - caution: - 'M4.47.22A.749.749 0 0 1 5 0h6c.199 0 .389.079.53.22l4.25 4.25c.141.14.22.331.22.53v6a.749.749 0 0 1-.22.53l-4.25 4.25A.749.749 0 0 1 11 16H5a.749.749 0 0 1-.53-.22L.22 11.53A.749.749 0 0 1 0 11V5c0-.199.079-.389.22-.53Zm.84 1.28L1.5 5.31v5.38l3.81 3.81h5.38l3.81-3.81V5.31L10.69 1.5ZM8 4a.75.75 0 0 1 .75.75v3.5a.75.75 0 0 1-1.5 0v-3.5A.75.75 0 0 1 8 4Zm0 8a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z', -}; - -export function alertIcon(type: IconType): Element { - let pathD = pathData[type] ?? ''; - return { - type: 'element', - tagName: 'svg', - properties: { - className: ['octicon'], - viewBox: '0 0 16 16', - width: '16', - height: '16', - ariaHidden: 'true', - }, - children: [ - { - type: 'element', - properties: { - d: pathD, - }, - tagName: 'path', - children: [], - }, - ], - }; -} diff --git a/core/src/preview.tsx b/core/src/preview.tsx index 1304ea25..f195d804 100644 --- a/core/src/preview.tsx +++ b/core/src/preview.tsx @@ -3,8 +3,8 @@ import ReactMarkdown, { type UrlTransform } from 'react-markdown'; import { type PluggableList } from 'unified'; import gfm from 'remark-gfm'; import raw from 'rehype-raw'; +import { remarkAlert } from 'remark-github-blockquote-alert'; import { useCopied } from './plugins/useCopied'; -import { remarkAlert } from './plugins/remarkAlert'; import { type MarkdownPreviewProps, type MarkdownPreviewRef } from './Props'; import './styles/markdown.less'; @@ -34,7 +34,7 @@ export default React.forwardRef((props useImperativeHandle(ref, () => ({ ...props, mdp }), [mdp, props]); const cls = `${prefixCls || ''} ${className || ''}`; useCopied(mdp); - const rehypePlugins: PluggableList = [[remarkAlert], ...(other.rehypePlugins || [])]; + const rehypePlugins: PluggableList = [...(other.rehypePlugins || [])]; const customProps: MarkdownPreviewProps = { allowElement: (element, index, parent) => { if (other.allowElement) { @@ -46,7 +46,7 @@ export default React.forwardRef((props if (skipHtml) { rehypePlugins.push(raw); } - const remarkPlugins = [...(other.remarkPlugins || []), gfm]; + const remarkPlugins = [remarkAlert, ...(other.remarkPlugins || []), gfm]; const wrapperProps = { ...warpperElement, ...wrapperElement }; return (
diff --git a/core/src/styles/markdown.less b/core/src/styles/markdown.less index 922593a7..cf111f35 100644 --- a/core/src/styles/markdown.less +++ b/core/src/styles/markdown.less @@ -1080,6 +1080,9 @@ body[data-color-mode*='light'] { display: flex; align-items: center; line-height: 1; + font-weight: 600; + font-family: initial; + font-size: 14px; svg.octicon { margin-right: var(--base-size-8, 8px) !important; }