@aiquants/markdown 4.0.0 → 6.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +107 -20
- package/dist/{abnfDiagram-VRR7QNED-utxwo7Ri.js → abnfDiagram-VRR7QNED-D7Rp9EaV.js} +3 -3
- package/dist/{abnfDiagram-VRR7QNED-DL9JJfMF.cjs → abnfDiagram-VRR7QNED-KTGT9TWM.cjs} +1 -1
- package/dist/{arc-BY7loL0l.cjs → arc-D5T_urCC.cjs} +1 -1
- package/dist/arc-DzZml7Bc.js +83 -0
- package/dist/{architectureDiagram-ZJ3FMSHR-CLLwinmD.cjs → architectureDiagram-ZJ3FMSHR-BOo3y9aD.cjs} +1 -1
- package/dist/{architectureDiagram-ZJ3FMSHR-DpnBy_s1.js → architectureDiagram-ZJ3FMSHR-DLrGYTYy.js} +123 -123
- package/dist/{blockDiagram-677ZJIJ3-C8dybZZU.js → blockDiagram-677ZJIJ3-B60l5Fpl.js} +166 -166
- package/dist/{blockDiagram-677ZJIJ3-Cs5tpWQ-.cjs → blockDiagram-677ZJIJ3-DnjCjo0a.cjs} +1 -1
- package/dist/{c4Diagram-LMCZKHZV-3aG0bDyP.js → c4Diagram-LMCZKHZV-BmbplKCu.js} +2 -2
- package/dist/{c4Diagram-LMCZKHZV-B-rz2a3v.cjs → c4Diagram-LMCZKHZV-bd8fWQ1F.cjs} +1 -1
- package/dist/channel-B3oXm84X.js +5 -0
- package/dist/{channel-Dn2hPSB8.cjs → channel-DJ_PyD9w.cjs} +1 -1
- package/dist/{chunk-2Q5K7J3B-CYpyj9EA.js → chunk-2Q5K7J3B-C0hbxO3D.js} +1 -1
- package/dist/{chunk-2Q5K7J3B-B7QkO_05.cjs → chunk-2Q5K7J3B-CWLCO342.cjs} +1 -1
- package/dist/{chunk-32BRIVSS-BjI5igEa.cjs → chunk-32BRIVSS-Cb9nTxqN.cjs} +1 -1
- package/dist/{chunk-32BRIVSS-DcLe6F1l.js → chunk-32BRIVSS-DUWtkDEY.js} +1 -1
- package/dist/{chunk-5VM5RSS4-C4ILSCRb.js → chunk-5VM5RSS4-C3mSh-gE.js} +1 -1
- package/dist/{chunk-5VM5RSS4-DafQyxAv.cjs → chunk-5VM5RSS4-DHA5n_Ls.cjs} +1 -1
- package/dist/{chunk-EX3LRPZG-BXZDK2R1.cjs → chunk-EX3LRPZG-ByY6_kep.cjs} +1 -1
- package/dist/{chunk-EX3LRPZG-CTaiVHYY.js → chunk-EX3LRPZG-DCF1zjtT.js} +50 -50
- package/dist/{chunk-JWPE2WC7-B-nuuS4b.js → chunk-JWPE2WC7-CPLOunIL.js} +1 -1
- package/dist/{chunk-JWPE2WC7-CNZBI1Pb.cjs → chunk-JWPE2WC7-CUBzYD4G.cjs} +1 -1
- package/dist/{chunk-MOJQB5TN-D1oF99aM.js → chunk-MOJQB5TN-CmOhW6SK.js} +9 -9
- package/dist/{chunk-MOJQB5TN-Dh_1HfSC.cjs → chunk-MOJQB5TN-P8-yb3-j.cjs} +1 -1
- package/dist/{chunk-PUDLZKDR-CPadtN2C.js → chunk-PUDLZKDR-DH7B7ZTK.js} +22 -22
- package/dist/{chunk-PUDLZKDR-CMFJFweY.cjs → chunk-PUDLZKDR-pKdIELvz.cjs} +1 -1
- package/dist/{chunk-RYQCIY6F-DxuegR0d.js → chunk-RYQCIY6F-C7ytn_QX.js} +6 -6
- package/dist/{chunk-RYQCIY6F-C6453DQl.cjs → chunk-RYQCIY6F-DcvQCEoc.cjs} +1 -1
- package/dist/{chunk-V7JOEXUC-ziE5DrnY.js → chunk-V7JOEXUC-BgLcssUF.js} +5 -5
- package/dist/{chunk-V7JOEXUC-l9PaMPOT.cjs → chunk-V7JOEXUC-CtXgqODy.cjs} +1 -1
- package/dist/{chunk-VR4S4FIN-BiCYvwb8.js → chunk-VR4S4FIN-BK6xeIQk.js} +3 -3
- package/dist/{chunk-VR4S4FIN-CCCnXTuJ.cjs → chunk-VR4S4FIN-Cc4GDi2Z.cjs} +1 -1
- package/dist/{chunk-XXDRQBXY-BFKT7vFo.js → chunk-XXDRQBXY-COtZ25Ez.js} +1 -1
- package/dist/{chunk-XXDRQBXY-D5IbqpUM.cjs → chunk-XXDRQBXY-D1OixGzR.cjs} +1 -1
- package/dist/{classDiagram-OUVF2IWQ-C1AZm4pB.cjs → classDiagram-OUVF2IWQ-DDLmqaG6.cjs} +1 -1
- package/dist/{classDiagram-v2-EOCWNBFH-KA_F_TBQ.js → classDiagram-OUVF2IWQ-Jc-IwOm0.js} +2 -2
- package/dist/{classDiagram-v2-EOCWNBFH-C1AZm4pB.cjs → classDiagram-v2-EOCWNBFH-DDLmqaG6.cjs} +1 -1
- package/dist/{classDiagram-OUVF2IWQ-KA_F_TBQ.js → classDiagram-v2-EOCWNBFH-Jc-IwOm0.js} +2 -2
- package/dist/components/MarkdownRenderer.d.ts +6 -3
- package/dist/components/MarkdownViewer.d.ts +3 -2
- package/dist/components/NodesRenderer.d.ts +1 -5
- package/dist/components/embeds/ClientFrame.d.ts +13 -0
- package/dist/components/embeds/LinkCard.d.ts +9 -0
- package/dist/components/embeds/ProviderEmbed.d.ts +11 -0
- package/dist/components/embeds/embedLabels.d.ts +12 -0
- package/dist/components/embeds/frameMessages.d.ts +7 -0
- package/dist/components/embeds/markdownEmbeds.d.ts +2 -0
- package/dist/components/embeds/requestQueue.d.ts +16 -0
- package/dist/components/embeds.d.ts +0 -8
- package/dist/components/htmlSanitizer.d.ts +4 -0
- package/dist/components/mdastNodes/HTMLBlockContainerNode.d.ts +1 -2
- package/dist/components/rawHtml.d.ts +6 -3
- package/dist/components/viewerLabels.d.ts +3 -1
- package/dist/{cose-bilkent-JH36ORCC-B_16TV-v.js → cose-bilkent-JH36ORCC-DaucPocG.js} +1 -1
- package/dist/{cose-bilkent-JH36ORCC-BQ2K2GyI.cjs → cose-bilkent-JH36ORCC-OwiXHdQY.cjs} +1 -1
- package/dist/css/zenn-content.css +0 -40
- package/dist/{cynefinDiagram-TSTJHNR4-Dq7UoRYB.cjs → cynefinDiagram-TSTJHNR4-Ag-HcuUm.cjs} +1 -1
- package/dist/{cynefinDiagram-TSTJHNR4-DTV6ORFc.js → cynefinDiagram-TSTJHNR4-Dkmz7gDw.js} +47 -47
- package/dist/{dagre-VKFMJZFB-kSrm5dp4.js → dagre-VKFMJZFB-BHGdcjt3.js} +27 -27
- package/dist/{dagre-VKFMJZFB-PCi8s-PP.cjs → dagre-VKFMJZFB-Q4CcAQ09.cjs} +1 -1
- package/dist/{diagram-FQU43EPY-D3dKlAPv.js → diagram-FQU43EPY-DBASKnKu.js} +42 -42
- package/dist/{diagram-FQU43EPY-wTUTIyQQ.cjs → diagram-FQU43EPY-jWCrN_AW.cjs} +1 -1
- package/dist/{diagram-G47NLZAW-_4FrgCGJ.cjs → diagram-G47NLZAW-B4XMStX7.cjs} +1 -1
- package/dist/{diagram-G47NLZAW-HJlhMCYj.js → diagram-G47NLZAW-BY1mmnYA.js} +83 -83
- package/dist/{diagram-NH7WQ7WH-ByCeah-n.cjs → diagram-NH7WQ7WH-BS1eEa9R.cjs} +1 -1
- package/dist/{diagram-NH7WQ7WH-CgeHmdJL.js → diagram-NH7WQ7WH-BXFvYRtm.js} +18 -18
- package/dist/{diagram-OA4YK3LP-C0IhePjD.cjs → diagram-OA4YK3LP-CTaL_2Nc.cjs} +1 -1
- package/dist/{diagram-OA4YK3LP-CwJcZGHD.js → diagram-OA4YK3LP-DgGrzezu.js} +61 -61
- package/dist/{diagram-WEI45ONY-v1LUmWAx.js → diagram-WEI45ONY-BHxWKH3v.js} +21 -21
- package/dist/{diagram-WEI45ONY-Cf-TVNEb.cjs → diagram-WEI45ONY-DX7BGSMI.cjs} +1 -1
- package/dist/{ebnfDiagram-CCIWWBDH-DqZtnwGP.js → ebnfDiagram-CCIWWBDH-BUK_anpV.js} +5 -5
- package/dist/{ebnfDiagram-CCIWWBDH-k5XOUGml.cjs → ebnfDiagram-CCIWWBDH-BpDmVVJY.cjs} +1 -1
- package/dist/embeds/frames.d.ts +4 -0
- package/dist/embeds/linkCards.d.ts +16 -0
- package/dist/embeds/placeholder.d.ts +15 -0
- package/dist/embeds/providers.d.ts +73 -0
- package/dist/embeds/testing.cjs +1 -0
- package/dist/embeds/testing.d.ts +7 -0
- package/dist/embeds/testing.js +67 -0
- package/dist/embeds.cjs +1 -0
- package/dist/embeds.d.ts +4 -0
- package/dist/embeds.js +94 -0
- package/dist/{erDiagram-Q63AITRT-DFet1VTy.cjs → erDiagram-Q63AITRT-Cd9H9BtP.cjs} +1 -1
- package/dist/{erDiagram-Q63AITRT-D6kP6d5J.js → erDiagram-Q63AITRT-Qb2bmkNp.js} +9 -9
- package/dist/{extractHeadings-B2I83li5.js → extractHeadings-B2pUyEPa.js} +5603 -5517
- package/dist/extractHeadings-DgefF9l1.cjs +311 -0
- package/dist/flowDiagram-23GEKE2U-BOmNlv7X.cjs +1 -0
- package/dist/flowDiagram-23GEKE2U-DMZnRz-6.js +7 -0
- package/dist/{ganttDiagram-NO4QXBWP-I9DxJwkX.js → ganttDiagram-NO4QXBWP-BVISsrzr.js} +69 -69
- package/dist/{ganttDiagram-NO4QXBWP-CEQqLRYx.cjs → ganttDiagram-NO4QXBWP-C6-ExcDz.cjs} +1 -1
- package/dist/{gitGraphDiagram-IHSO6WYX-p_7WQssC.js → gitGraphDiagram-IHSO6WYX-BDVA2TFP.js} +38 -38
- package/dist/{gitGraphDiagram-IHSO6WYX-yyEwsmHH.cjs → gitGraphDiagram-IHSO6WYX-DLzPc702.cjs} +1 -1
- package/dist/index.cjs +1 -1
- package/dist/index.client.cjs +1 -1
- package/dist/index.client.d.ts +1 -10
- package/dist/index.client.js +41 -49
- package/dist/index.js +41 -49
- package/dist/index.server.cjs +1 -1
- package/dist/index.server.d.ts +0 -2
- package/dist/index.server.js +123 -168
- package/dist/{infoDiagram-FWYZ7A6U-C9L5rIcg.js → infoDiagram-FWYZ7A6U-D31UwqjR.js} +1 -1
- package/dist/{infoDiagram-FWYZ7A6U-BFCkTfAI.cjs → infoDiagram-FWYZ7A6U-DMF_wb2h.cjs} +1 -1
- package/dist/{ishikawaDiagram-FXEZZL3T-B3TjOzka.cjs → ishikawaDiagram-FXEZZL3T-DUlnwraq.cjs} +1 -1
- package/dist/{ishikawaDiagram-FXEZZL3T-uxcpJtLF.js → ishikawaDiagram-FXEZZL3T-XA6-gyHY.js} +35 -35
- package/dist/{journeyDiagram-5HDEW3XC-DMq3piuW.js → journeyDiagram-5HDEW3XC-B8sfsWpu.js} +39 -39
- package/dist/{journeyDiagram-5HDEW3XC-CvtPgaNR.cjs → journeyDiagram-5HDEW3XC-CwQyFcYa.cjs} +1 -1
- package/dist/{kanban-definition-HUTT4EX6-DJ9sXiRP.cjs → kanban-definition-HUTT4EX6-BjPlt2-E.cjs} +1 -1
- package/dist/{kanban-definition-HUTT4EX6-Dfal8jdL.js → kanban-definition-HUTT4EX6-FTrTBare.js} +123 -123
- package/dist/{linear-CLykHvhQ.cjs → linear-D3AJM3sY.cjs} +1 -1
- package/dist/{linear-CvzPdVAO.js → linear-DI9P_z72.js} +32 -32
- package/dist/markdown.css +1 -1
- package/dist/{mindmap-definition-LN4V7U3C-CErimIK1.cjs → mindmap-definition-LN4V7U3C-CxgWZidl.cjs} +1 -1
- package/dist/{mindmap-definition-LN4V7U3C-C8erO2Mh.js → mindmap-definition-LN4V7U3C-YW4YcL9x.js} +33 -33
- package/dist/{pegDiagram-2B236MQR-DBL8X0k9.cjs → pegDiagram-2B236MQR-CUo7q5bl.cjs} +1 -1
- package/dist/{pegDiagram-2B236MQR-CECcXaCN.js → pegDiagram-2B236MQR-sJjLKeF3.js} +5 -5
- package/dist/{pieDiagram-ENE6RG2P-B_-x0Nvj.cjs → pieDiagram-ENE6RG2P-Cy_sUuLQ.cjs} +1 -1
- package/dist/{pieDiagram-ENE6RG2P-CWlf16nv.js → pieDiagram-ENE6RG2P-D4VanIOv.js} +58 -58
- package/dist/providers-Bxr2Wb-j.cjs +1 -0
- package/dist/providers-Drq7MT_K.js +209 -0
- package/dist/{quadrantDiagram-ABIIQ3AL-HKlopKX4.cjs → quadrantDiagram-ABIIQ3AL-D3c8xLpt.cjs} +1 -1
- package/dist/{quadrantDiagram-ABIIQ3AL-JpouSW89.js → quadrantDiagram-ABIIQ3AL-ubxphjb_.js} +48 -48
- package/dist/{railroadDiagram-RFXS5EU6-CLTBEsir.js → railroadDiagram-RFXS5EU6-DvpD4C_A.js} +3 -3
- package/dist/{railroadDiagram-RFXS5EU6-B-v61EFn.cjs → railroadDiagram-RFXS5EU6-_Q4W5hB-.cjs} +1 -1
- package/dist/{requirementDiagram-TGXJPOKE-4vCejkrF.cjs → requirementDiagram-TGXJPOKE-DdYIO-wU.cjs} +1 -1
- package/dist/{requirementDiagram-TGXJPOKE-DtoTpDLe.js → requirementDiagram-TGXJPOKE-Dk_6BuX9.js} +3 -3
- package/dist/{sankeyDiagram-HTMAVEWB-WxnjUz1I.js → sankeyDiagram-HTMAVEWB-s3Kd7T8n.js} +67 -67
- package/dist/{sankeyDiagram-HTMAVEWB-Bp8p_ojk.cjs → sankeyDiagram-HTMAVEWB-zuYg6LTg.cjs} +1 -1
- package/dist/{sequenceDiagram-DBY2YBRQ-BUPaWSIG.cjs → sequenceDiagram-DBY2YBRQ-BvNPCevg.cjs} +1 -1
- package/dist/{sequenceDiagram-DBY2YBRQ-DGJcC2MQ.js → sequenceDiagram-DBY2YBRQ-YQic4wxL.js} +47 -47
- package/dist/{sizeCapture-X5ZJPWSS-Dk82fAT8.cjs → sizeCapture-X5ZJPWSS-BqrdzzsI.cjs} +1 -1
- package/dist/{sizeCapture-X5ZJPWSS-BmP0pJAx.js → sizeCapture-X5ZJPWSS-qMsWGfjy.js} +1 -1
- package/dist/{stateDiagram-2N3HPSRC-ZL_eFTbb.js → stateDiagram-2N3HPSRC-D1Ub8LYq.js} +22 -22
- package/dist/{stateDiagram-2N3HPSRC-CL5Omkqs.cjs → stateDiagram-2N3HPSRC-Ds8f-scd.cjs} +1 -1
- package/dist/{stateDiagram-v2-6OUMAXLB-BgOqjiSL.js → stateDiagram-v2-6OUMAXLB-DW8wjtk3.js} +2 -2
- package/dist/{stateDiagram-v2-6OUMAXLB-D3Zgp8xl.cjs → stateDiagram-v2-6OUMAXLB-PmrsPXuZ.cjs} +1 -1
- package/dist/styles/markdown.css +1 -1
- package/dist/{swimlanes-5IMT3BWC-GB1p75ou.js → swimlanes-5IMT3BWC-C8P8vU0w.js} +313 -313
- package/dist/{swimlanes-5IMT3BWC-CuW1KWfs.cjs → swimlanes-5IMT3BWC-jZhcesRT.cjs} +1 -1
- package/dist/{swimlanesDiagram-G3AALYLV-Jr2ZWz3z.js → swimlanesDiagram-G3AALYLV-B9FKeJRf.js} +2 -2
- package/dist/{swimlanesDiagram-G3AALYLV-Di_Nug7g.cjs → swimlanesDiagram-G3AALYLV-M5Cg2MHU.cjs} +1 -1
- package/dist/{timeline-definition-FHXFAJF6-663e-yVA.js → timeline-definition-FHXFAJF6-Ch-He--D.js} +34 -34
- package/dist/{timeline-definition-FHXFAJF6-BKVe7Qad.cjs → timeline-definition-FHXFAJF6-DZm1-KlQ.cjs} +1 -1
- package/dist/{vennDiagram-L72KCM5P-BDGC8Vm3.js → vennDiagram-L72KCM5P-CaoPscCM.js} +92 -92
- package/dist/{vennDiagram-L72KCM5P-2NIIKtsl.cjs → vennDiagram-L72KCM5P-mUSI238J.cjs} +1 -1
- package/dist/{wardleyDiagram-EHGQE667-IbGr9hGV.js → wardleyDiagram-EHGQE667-CSAqF366.js} +11 -11
- package/dist/{wardleyDiagram-EHGQE667-BrTNZSmG.cjs → wardleyDiagram-EHGQE667-CkKP97H-.cjs} +1 -1
- package/dist/{xychartDiagram-FW5EYKEG-MCkmgF8g.cjs → xychartDiagram-FW5EYKEG-BivGpkVk.cjs} +1 -1
- package/dist/{xychartDiagram-FW5EYKEG-CbxKOQYO.js → xychartDiagram-FW5EYKEG-OEsTD_k4.js} +37 -37
- package/package.json +22 -8
- package/dist/arc-Byq9kr_0.js +0 -83
- package/dist/channel-BoXFYC1g.js +0 -5
- package/dist/components/mdastNodes/BlockLinkNode.d.ts +0 -5
- package/dist/components/mdastNodes/RichLinkCard.d.ts +0 -8
- package/dist/components/mdastNodes/TwitterEmbedNode.d.ts +0 -25
- package/dist/components/mdastNodes/YouTubeEmbedNode.d.ts +0 -6
- package/dist/extractHeadings-R7NxLZJP.cjs +0 -310
- package/dist/flowDiagram-23GEKE2U-BTXvBdte.js +0 -7
- package/dist/flowDiagram-23GEKE2U-C81VZYM7.cjs +0 -1
- package/dist/plugins/createIntentTweetLink.d.ts +0 -10
- package/dist/plugins/extractYouTubeVideoId.d.ts +0 -5
- package/dist/plugins/fetchSiteMetadata.d.ts +0 -9
- package/dist/plugins/remark-auto-heading-id.d.ts +0 -2
- package/dist/plugins/remark-block-link-metadata.d.ts +0 -23
- package/dist/plugins/remark-block-link.d.ts +0 -12
- package/dist/plugins/remark-twitter-embed.d.ts +0 -20
- package/dist/plugins/remark-youtube-embed.d.ts +0 -14
- package/dist/simple-logger-DZxBpX7v.cjs +0 -1
- package/dist/simple-logger-i94ikRyH.js +0 -101
- package/dist/utils/getFaviconUrl.d.ts +0 -1
package/README.md
CHANGED
|
@@ -6,7 +6,7 @@ Advanced Markdown renderer for React with support for various extensions and cus
|
|
|
6
6
|
|
|
7
7
|
- **Rich Markdown Support**: Full support for CommonMark, GitHub Flavored Markdown (GFM), and LaTeX Math expressions.
|
|
8
8
|
- **Offloaded Parser**: CPU-heavy Markdown parsing and AST transformation are offloaded to a high-performance Go API server running `goldmark` and `ConnectRPC`.
|
|
9
|
-
- **Custom Extensions & Plugins**: GitHub alerts, Zenn-style directives (`:::message` / `:::details`), single-line display math, and pluggable subscript, superscript, mark highlights, table cell merges and embeds
|
|
9
|
+
- **Custom Extensions & Plugins**: GitHub alerts, Zenn-style directives (`:::message` / `:::details`), single-line display math, and pluggable subscript, superscript, mark highlights, table cell merges, and opt-in embeds: posts and videos of ten SNS and video providers as script-free cross-origin frames, and link cards from the host's metadata endpoint.
|
|
10
10
|
- **Dynamic Configuration**: Easily enable or disable custom extensions dynamically using parse options.
|
|
11
11
|
- **Syntax Highlighting**: Code blocks with Shiki syntax highlighting.
|
|
12
12
|
- **TypeScript**: Full TypeScript support with comprehensive type definitions.
|
|
@@ -71,9 +71,13 @@ export MARKDOWN_API_BINARY=/path/to/markdown-api
|
|
|
71
71
|
|
|
72
72
|
```tsx
|
|
73
73
|
import { MarkdownRenderer } from "@aiquants/markdown"
|
|
74
|
+
import type { MarkdownEmbeds } from "@aiquants/markdown/embeds"
|
|
74
75
|
import { parseMarkdown } from "@aiquants/markdown/server"
|
|
75
76
|
import "@aiquants/markdown/styles/markdown.css"
|
|
76
77
|
|
|
78
|
+
// A module constant: the providers whose posts embed, and the host's link-card endpoint (see Embeds)
|
|
79
|
+
const EMBEDS: MarkdownEmbeds = { providers: ["youtube", "x"], linkCardEndpoint: "/api/site_metadata" }
|
|
80
|
+
|
|
77
81
|
const MyComponent = async () => {
|
|
78
82
|
const markdownText = `# Hello World
|
|
79
83
|
|
|
@@ -103,7 +107,7 @@ console.log("Hello, World!")
|
|
|
103
107
|
<MarkdownRenderer
|
|
104
108
|
htmlContent={parseResult.htmlContent}
|
|
105
109
|
theme="light"
|
|
106
|
-
|
|
110
|
+
embeds={EMBEDS}
|
|
107
111
|
/>
|
|
108
112
|
)
|
|
109
113
|
}
|
|
@@ -126,14 +130,14 @@ const parseResult = await parseMarkdown(
|
|
|
126
130
|
deniedPathSegments: hostDenyRules, // required; [] denies nothing
|
|
127
131
|
maxHtmlBytes: 4 * 1024 * 1024, // required; the largest HTML in bytes
|
|
128
132
|
resolveImports: false, // expand <!-- @import "path" --> (default false)
|
|
129
|
-
validateExistence: true, //
|
|
133
|
+
validateExistence: true, // probe local images and doc links (data-asset-exists / data-doc-exists; default true)
|
|
130
134
|
signal: controller.signal, // cancels the conversion in the service too
|
|
131
135
|
timeoutMs: 10_000, // the conversion's deadline
|
|
132
136
|
enableSubscript: false, // Disable subscript (leaves ~2~ as plain text)
|
|
133
137
|
enableSuperscript: true, // Enable superscript
|
|
134
138
|
enableMark: false, // Disable highlight mark
|
|
135
139
|
enableTableMerge: true, // Enable table merges (> and ^)
|
|
136
|
-
enableEmbeds: true, //
|
|
140
|
+
enableEmbeds: true, // Mark a paragraph holding one web link (data-embed-url)
|
|
137
141
|
enableZennDirectives: true // Enable :::message / :::details
|
|
138
142
|
}
|
|
139
143
|
)
|
|
@@ -144,18 +148,26 @@ const parseResult = await parseMarkdown(
|
|
|
144
148
|
| `deniedPathSegments` | ✅ | Deny rules applied to every target the conversion resolves: `@import` targets, images and links. A pattern matches one whole path segment (`*` matches any run of characters within it), compared after NFKC normalization and case folding at every percent-decoding level (the semantics of `@aiquants/markdown-explorer`'s deny rules). Local targets must also stay inside `workspaceRoot`, also once symbolic links are resolved. A refused image renders without `src`, a refused link without a destination (with `validateExistence`, both are marked like a missing target, whether or not the target exists), and a refused import rejects the call. |
|
|
145
149
|
| `maxHtmlBytes` | ✅ | The largest HTML in bytes, a positive integer up to `MAX_HTML_BYTES_LIMIT`. The service stops while it renders and the call rejects with `MarkdownResourceExhaustedError`; the response the call accepts is bounded by twice this plus 64 KiB. |
|
|
146
150
|
| `resolveImports` | | Expand `<!-- @import "path" -->` directives (default `false`: a directive stays an HTML comment and nothing is read). Only Markdown (`.md`) targets the deny rules admit are read, nested imports included; a refused target rejects the call with `permission_denied`. |
|
|
147
|
-
| `validateExistence` | |
|
|
151
|
+
| `validateExistence` | | Probe local targets (default `true`): a local storage image also gets `data-asset-exists` (`"true"` or `"false"`) and a local doc link `data-doc-exists` (`"true"` or `"false"`). Cloud targets are never probed, and `data-asset-src` is written for every admitted storage image either way. |
|
|
148
152
|
| `signal` | | Cancels the call; the service stops converting. |
|
|
149
153
|
| `timeoutMs` | | The conversion's deadline in milliseconds (a positive integer); the service stops at it or at `MARKDOWN_CONVERT_TIMEOUT`, whichever comes first. |
|
|
150
154
|
| `enable*` | | Switch the syntax extensions and HTML plugins (each enabled unless `false`). The text plugins leave `summary` text (a `:::details` title included) as written. |
|
|
151
155
|
|
|
152
156
|
Invalid options throw `TypeError` / `RangeError` before any request. A conversion stopped at a size limit (the HTML limit, the service's source limit or a message limit) rejects with `MarkdownResourceExhaustedError` (its `cause` is the connect error); every other failure rejects with the `ConnectError` of the service (`invalid_argument`, `permission_denied`, `canceled`, `deadline_exceeded`, `internal`).
|
|
153
157
|
|
|
154
|
-
###
|
|
158
|
+
### Image and link targets
|
|
155
159
|
|
|
160
|
+
The converter writes document paths, never URLs, so a host decides how its files are served.
|
|
156
161
|
An image destination is a URL decoded once: `` names the file `a%41.png`, while `` names `aA.png` (a `%` not followed by two hexadecimal digits, as in `100%.png`, may be written as it is).
|
|
157
|
-
|
|
158
|
-
|
|
162
|
+
|
|
163
|
+
- **Storage images** (a local file inside `workspaceRoot`, or a `gcs://` / `gdrive://` object) have no `src`. Their document path is in `data-asset-src`, unescaped: the path from `workspaceRoot` for a local file (`資料/進捗100%.png`, `x.data`), the URI decoded once for a cloud object (`gcs://bucket/reports/fig 1.png`). The host writes the `src` from it, encoding the path for its own route; no URL is signed.
|
|
164
|
+
- **Existence**: with `validateExistence`, a local storage image also carries `data-asset-exists` (`"true"` or `"false"`); a cloud image is never probed.
|
|
165
|
+
- **Refused targets** (the deny rules, or outside `workspaceRoot`) have neither a `src` nor `data-asset-src`; with `validateExistence` they carry `data-asset-exists="false"` whether or not they exist.
|
|
166
|
+
- **Storage links** are `data-link-kind="doc"`: they keep the authored `href` (its fragment is what a host reads) and carry the document path in `data-doc-path`; a local one also gets `data-doc-exists` under `validateExistence`.
|
|
167
|
+
- `data-asset-src` and `data-asset-exists` come only from the converter: markers written in the document's raw HTML or by an HTML plugin are removed.
|
|
168
|
+
- Of an element's duplicate attributes only the first counts, as in a browser: the converter drops the rest, so the HTML carries no duplicate attribute and a repeated `src` or marker cannot make the converter and the browser read different values.
|
|
169
|
+
|
|
170
|
+
`MarkdownRenderer` shows an image without a `src` (or with `data-asset-exists="false"`) as a placeholder naming its `data-asset-src`, so HTML rendered before the host wrote the URLs shows which files are missing instead of blank space.
|
|
159
171
|
|
|
160
172
|
## Viewer, embeds and links
|
|
161
173
|
|
|
@@ -179,31 +191,82 @@ Every renderer of the package — `MarkdownRenderer` (and so `MarkdownViewer`) f
|
|
|
179
191
|
- **Kept**: the elements Markdown produces and common text and structure elements (`a`, `img`, `p`, `div`, `span`, headings, lists, tables, `blockquote`, `pre`, `code`, `details`, `summary`, `aside`, `section`, `figure`, `sup`, `sub`, `mark`, `video`, `audio`, `source` …) and, for icons, an `svg` with `g` and `path` inside it (anything else inside an `svg` is removed).
|
|
180
192
|
- **Unwrapped** (the element is dropped, its children render): every other element — `form`, `button`, `textarea`, `label`, `font`, `center`, custom elements and the like — so its text survives.
|
|
181
193
|
- **Attributes**: `title`, `lang`, `dir`, `role`, `hidden`, `translate`, `aria-*`, a reduced `class`, `id` and `style`, and each element's own (`href`, `src`, `alt`, `width`, `height`, `colspan`, `rowspan`, `align`, `open`, `start` …; a link keeps `name`, the fragment target of older documents).
|
|
182
|
-
The `data-*` attributes the renderers read survive on their element only: `data-link-kind`, `data-doc-path`, `data-doc-exists`, `data-footnote-ref` and `data-footnote-backref` on links, `data-asset-src` and `data-asset-exists` on images, `data-footnotes` on sections
|
|
194
|
+
The `data-*` attributes the renderers read survive on their element only: `data-link-kind`, `data-doc-path`, `data-doc-exists`, `data-footnote-ref` and `data-footnote-backref` on links, `data-asset-src` and `data-asset-exists` on images, and `data-footnotes` on sections. A paragraph's `data-embed-url` never renders: when it is a safe URL the paragraph becomes an embed placeholder (see [Embeds](#embeds)); the 5.x `div` markers (`data-plugin-type`, `data-video-id`, `data-tweet-id`, `data-url`) are dropped.
|
|
195
|
+
Event handlers, `target`, `rel`, `name` (except on links), `srcset`, `usemap`, `ping`, `formaction`, `xlink:href`, `tabindex` and every other attribute are dropped.
|
|
183
196
|
- **Attribute names** are read as an HTML parser stores them: in lower case, and of names that differ only in case the first one written. Kept attributes carry lower-case names, so `<p STYLE="text-align:center">` or `<a HREF="https://…">` renders the same on the server (where html-react-parser keeps the author's case) and in the browser, and hydrates without a mismatch.
|
|
184
197
|
- **`class`** keeps only the package's own tokens: the converter's markup (`markdown-alert`, `markdown-alert-{note,tip,important,warning,caution}`, `markdown-alert-title`, `octicon`, `octicon-{info,light-bulb,report,alert,stop}`, `mr-2`, `message`, `alert`, `info`, `warning`, `message-symbol`, `message-content`, `markdown-details`, `markdown-details-content`, `footnotes`, `footnote-ref`, `footnote-backref`, `math`, `inline`, `display`) and a code block's language (`language-*`).
|
|
185
198
|
An author's tokens and utility classes (`fixed inset-0 z-50` …) are dropped, so a document can neither restyle the page nor lay an element over it; a link's `className` (also the one `linkComponent` receives) holds only the kept tokens and the package's link classes. Tables carry their alignment in `align` and `style`, not in classes.
|
|
186
199
|
- **`id`** survives only on a heading (the table of contents, in-document links and a host's fragment navigation name headings by it), on the converter's footnotes (`fnref:N` / `fnrefK:N` on a reference's `sup`, `fn:N` on a note's `li`) and in the user-content namespace (`user-content-…`, the prefix GitHub-style footnotes use; write raw HTML fragment targets with it, or as `<a name="…">`).
|
|
187
|
-
Every other element loses its id, so a document cannot take a name the page or a script looks up (`getElementById`, the named properties of `window`). A heading keeps whatever id the document gives it: a host should not look up its own elements by an id a document could also give a heading (prefer refs)
|
|
200
|
+
Every other element loses its id, so a document cannot take a name the page or a script looks up (`getElementById`, the named properties of `window`). A heading keeps whatever id the document gives it: a host should not look up its own elements by an id a document could also give a heading (prefer refs).
|
|
188
201
|
- **Host sanitizers**: a host that sanitizes the HTML before the renderer (as `@aiquants/markdown-explorer` does with DOMPurify) gets the intersection of both allow lists; DOMPurify keeps `class` and `id` by default, so on the page the rules above are the ones that apply.
|
|
189
|
-
- **URLs** (`href`, `src`, `cite`, `poster`, `data-url`): `http:`, `https:`, `mailto:` and `tel:` in any letter case, and references without a scheme. `javascript:`, `data:` and every other scheme are dropped, however they are spelled (entities, spaces, tabs, control characters). The mdast `LinkNode` and `ImageNode`,
|
|
202
|
+
- **URLs** (`href`, `src`, `cite`, `poster`, `data-embed-url`): `http:`, `https:`, `mailto:` and `tel:` in any letter case, and references without a scheme. `javascript:`, `data:` and every other scheme are dropped, however they are spelled (entities, spaces, tabs, control characters). The mdast `LinkNode` and `ImageNode`, link cards (their link, image and icon) and the table of contents' entries follow the same rule.
|
|
190
203
|
- **`style`** keeps only its last valid `text-align` declaration (the alignment of table cells); positioning, `url()` and every other declaration are dropped. An SVG `fill` that references anything (`url(…)`) is dropped.
|
|
191
204
|
|
|
192
205
|
### Embeds
|
|
193
206
|
|
|
194
|
-
|
|
195
|
-
`allow` keeps each feature's name without its allowlist, so a feature applies to the embedded origin only (`camera *; microphone 'self' https://x.example` becomes `camera; microphone`); `referrerpolicy` is kept only as `no-referrer`, `origin`, `same-origin`, `strict-origin` or `strict-origin-when-cross-origin`.
|
|
196
|
-
- An iframe plugin (`data-plugin-type="dify"`) receives the validated iframe as structured props, never as an HTML string. The Dify plugin acts only on messages its own frame's window posts from an allowed origin, and ignores a message that is not an object with a string `type`.
|
|
197
|
-
- A YouTube embed loads the player only when `www.youtube.com` is in `iFrameAllowedDomains`; otherwise it renders a link to the video's watch page.
|
|
198
|
-
- A tweet renders as a link to its address unless the host sets `allowTwitterWidgetScript` (on `MarkdownRenderer` and `MarkdownViewer`), which lets the page load and run `https://platform.twitter.com/widgets.js`. The widgets are taken from that script only: an existing copy is found as a `script` element with that `src` (never by the `twitter-wjs` id), and `window.twttr.widgets` is used only when its `createTweet` is a function, so an element a document names `twitter-wjs` or `twttr` cannot block or impersonate it.
|
|
207
|
+
Embeds are opt in. `MarkdownRenderer` and `MarkdownViewer` take `embeds={{ providers, linkCardEndpoint }}` (type `MarkdownEmbeds` from `@aiquants/markdown/embeds`); the default `NO_EMBEDS` renders every link alone in a paragraph as that paragraph. Pass the value from a module constant (the viewer also compares it by value). An unknown provider id or a bad endpoint throws a `RangeError` at render.
|
|
199
208
|
|
|
200
209
|
```tsx
|
|
201
|
-
|
|
210
|
+
import type { MarkdownEmbeds } from "@aiquants/markdown/embeds"
|
|
211
|
+
|
|
212
|
+
const EMBEDS: MarkdownEmbeds = { providers: ["youtube", "x", "instagram", "bluesky"], linkCardEndpoint: "/api/site_metadata" }
|
|
213
|
+
|
|
214
|
+
<MarkdownViewer {...props} embeds={EMBEDS} iFrameAllowedDomains={["www.youtube.com"]} />
|
|
202
215
|
```
|
|
203
216
|
|
|
217
|
+
**What a link alone in a paragraph becomes.** The converter marks a paragraph whose only element is one link to an absolute `http(s)` URL without a user name or password (besides white space, U+00A0 and U+3000) with `data-embed-url`, and keeps the paragraph and the link. The renderer then decides, in this order:
|
|
218
|
+
|
|
219
|
+
1. The marked link must be the paragraph's only link, with the same sanitized `href` (`placeholderLinkOf`); otherwise the paragraph renders as written.
|
|
220
|
+
2. The fallback is a link card when `linkCardEndpoint` is set and the link's text is the URL itself (`isBareLink`), otherwise the paragraph.
|
|
221
|
+
3. An enabled provider that recognizes the URL embeds its post or video, whatever the link text says, with the paragraph's own link as the caption; otherwise the fallback renders.
|
|
222
|
+
|
|
223
|
+
The link is always kept: under the frame, as the card, or as the paragraph.
|
|
224
|
+
|
|
225
|
+
| Provider id | URLs it recognizes | Frame origin |
|
|
226
|
+
| --- | --- | --- |
|
|
227
|
+
| `youtube` | `www.youtube.com`, `youtube.com`, `m.youtube.com`: `/watch?v=` (any position; `si`, `list`, `feature` ignored), `/shorts/ID`, `/live/ID`, `/embed/ID`; `youtu.be/ID`; `www.youtube-nocookie.com/embed/ID` | `https://www.youtube-nocookie.com` |
|
|
228
|
+
| `x` | `x.com`, `twitter.com` (`www.`, `mobile.`): `/USER/status/ID` (with `/photo/N` or `/video/N`), `/i/web/status/ID` | `https://platform.twitter.com` |
|
|
229
|
+
| `instagram` | `www.instagram.com`, `instagram.com`, `instagr.am`: `/p/CODE`, `/reel/CODE`, `/USER/p/CODE`, `/USER/reel/CODE` | `https://www.instagram.com` |
|
|
230
|
+
| `threads` | `www.threads.com`, `threads.com`, `www.threads.net`, `threads.net`: `/@USER/post/CODE` | `https://www.threads.com` |
|
|
231
|
+
| `tiktok` | `www.tiktok.com`, `tiktok.com`: `/@USER/video/ID`, `/player/v1/ID`, `/embed/v2/ID` | `https://www.tiktok.com` |
|
|
232
|
+
| `bluesky` | `bsky.app/profile/ACTOR/post/RKEY` (a DID, or a handle looked up at `https://public.api.bsky.app`) | `https://embed.bsky.app` |
|
|
233
|
+
| `linkedin` | `www.linkedin.com`, `linkedin.com`: `/feed/update/URN`, `/embed/feed/update/URN`, `/posts/…-activity-ID-…` | `https://www.linkedin.com` |
|
|
234
|
+
| `reddit` | `www.reddit.com`, `reddit.com`, `old.reddit.com`, `new.reddit.com`: `/r/SUB/comments/ID[/SLUG]` | `https://embed.reddit.com` |
|
|
235
|
+
| `note` | `note.com/USER/n/KEY` | `https://note.com` |
|
|
236
|
+
| `niconico` | `www.nicovideo.jp`, `nicovideo.jp`: `/watch/ID`; `nico.ms/ID` | `https://embed.nicovideo.jp` |
|
|
237
|
+
|
|
238
|
+
Every host must match exactly (look-alike hosts, user info, ports and URLs carrying a provider URL in their query never match), and each path segment must match its own grammar. Short links without an id, Facebook, Pinterest, TikTok photo posts and LinkedIn articles have no provider: as bare URLs they become cards.
|
|
239
|
+
|
|
240
|
+
**Frames.** No provider script ever runs in the page: posts and videos are cross-origin iframes with the registry's attributes (an `allow` within the six shared features, a `sandbox`, a referrer policy, `loading="lazy"`), titled `"<provider>: <label>"`. Every iframe — provider frames, iframes written in documents and the Dify plugin — mounts only on the client after hydration, and **never when its origin is the page's own origin**, whatever the host allows.
|
|
241
|
+
The server HTML holds the link and a reserved box (`width: 100%` up to the provider's maximum, its aspect ratio or height, never a CSS `min-width`), hidden for readers without JavaScript. A frame whose box is narrower than the provider's minimum (YouTube 356 px, Shorts 200 px, X 250 px, Instagram 326 px, Threads 281 px, Bluesky 300 px) shows the fallback instead, and mounts again when the pane widens. X follows the primary subtag of the page's `<html lang>`; X, Threads and Bluesky follow `theme`.
|
|
242
|
+
Frames that report their height (X, Instagram, Threads, Bluesky, Reddit, note) are sized through one `message` listener that accepts only the frame's own window from its exact provider origin.
|
|
243
|
+
|
|
244
|
+
**Link cards.** A card asks `GET <linkCardEndpoint>?url=<href>` (same-origin credentials, `redirect: "error"`) once an IntersectionObserver rooted at the viewer's scroller sees it, through a page-wide queue (two requests at once, 256 answers kept, aborted when no card needs the answer).
|
|
245
|
+
It links to the written `href` (never `og:url`), takes the host name from the `href`, and shows the image and the icon only when the endpoint gives absolute `http(s)` URLs that are not on the page's own host, whatever the scheme or port (a browser loads an `http:` image of an `https:` page over `https:`, and cookies ignore the port), with no referrer. The package asks no favicon service. Any failure renders the paragraph.
|
|
246
|
+
|
|
247
|
+
The endpoint contract:
|
|
248
|
+
|
|
249
|
+
- `GET <endpoint>?url=<href>` answers JSON `{ title?, description?, site_name?, image?, icon? }`; other fields (`url` included) are ignored.
|
|
250
|
+
- It must not set cookies or refresh credentials: the request runs in the background and can be in flight during a sign-out.
|
|
251
|
+
- A redirect, a 401, any other non-OK status or a non-JSON answer means no card.
|
|
252
|
+
|
|
253
|
+
**Iframes written in documents.** `iFrameAllowedDomains` lists the hostnames such an iframe may load from: the `src` must be `https:`, without a user name, a password or an explicit port, and its hostname must match an entry exactly. Every other iframe is removed (fail closed), including an iframe without `src` (`srcdoc`). An allowed iframe is rendered from validated values and keeps only `title`, `width`, `height`, `allow`, `allowfullscreen`, `sandbox`, `referrerpolicy`, `loading`, `frameborder` and `scrolling` (no `id` or `class`).
|
|
254
|
+
An iframe without a `title` gets `"<embeddedFrame>: <host>"` (for example `Embedded content: www.youtube.com`), marked with the built-in label's language.
|
|
255
|
+
`allow` keeps only the six shared frame features — `autoplay`, `clipboard-write`, `encrypted-media`, `fullscreen`, `picture-in-picture`, `web-share` — each without its allowlist (`camera; microphone; autoplay` becomes `autoplay`); `referrerpolicy` is kept only as `no-referrer`, `origin`, `same-origin`, `strict-origin` or `strict-origin-when-cross-origin`. Until it mounts, and for good when its origin is the page's, the iframe renders as `<span data-embed-frame="pending|refused">` holding a link to its `src`.
|
|
256
|
+
An iframe inside a link never mounts and stays that text, without a nested link: interactive content may not sit inside an `<a>`, and activating the link would follow the author's URL instead of the frame.
|
|
257
|
+
An iframe plugin (`data-plugin-type="dify"`) receives the validated iframe as structured props, never as an HTML string. The Dify plugin acts only on messages its own frame's window posts from an allowed origin, and ignores a message that is not an object with a string `type`.
|
|
258
|
+
|
|
259
|
+
**Labels.** `embedLabels` (`embeddedVideo`, `embeddedPost`, `embeddedFrame`; built-in "embedded video", "embedded post", "Embedded content", in `DEFAULT_MARKDOWN_EMBED_LABELS`) name the frames; `MarkdownViewer` takes the same keys in `labels`.
|
|
260
|
+
|
|
261
|
+
**DOM hooks.** `figure[data-embed-provider][data-embed-state="pending|frame"]` with its box `[data-embed-box]`, the width probe `[data-embed-measure]`, `span[data-embed-frame]` for iframes written in documents, and `a[data-link-card="pending|ready"]`.
|
|
262
|
+
|
|
263
|
+
**Content Security Policy.** Put `embedFrameHostsOf(embeds.providers)` and the hosts of `iFrameAllowedDomains` in `frame-src`, `embedConnectOriginsOf(embeds.providers)` in `connect-src` (Bluesky handles), and allow `https:` images in `img-src` for card images and icons. Provider frames may open popups that escape their sandbox, so a host that enables providers should send `Cross-Origin-Opener-Policy: same-origin`.
|
|
264
|
+
|
|
265
|
+
`@aiquants/markdown/embeds` holds the placeholder contract, the frame policy, the provider registry and the card contract without React, for host sanitizers, configuration and CSP. `@aiquants/markdown/embeds/testing` holds captured provider messages and `embedProviderStubPage(url)` for offline end-to-end tests.
|
|
266
|
+
|
|
204
267
|
### Links
|
|
205
268
|
|
|
206
|
-
- A link is external when its `href` names a scheme in any case (`https:`, `HTTPS:`, `mailto:`) or another host (`//host/…`, `/\host/…`), whatever its `data-link-kind` says
|
|
269
|
+
- A link is external when its `href` names a scheme in any case (`https:`, `HTTPS:`, `mailto:`) or another host (`//host/…`, `/\host/…`), whatever its `data-link-kind` says, and when `data-link-kind` is `external`. An external link opens in a new tab with `rel="noreferrer"` and is never handed to `linkComponent`. The author's `target` and `rel` never survive.
|
|
207
270
|
- `linkComponent` receives `href`, `kind`, `docPath`, `docExists`, `className`, `children` and `attributes`: the link's `id`, `title`, `lang`, `dir`, `role`, `aria-*` and `data-footnote-*` (event handlers, `style` and `href`-like attributes never pass). Spread `attributes` onto the anchor you render so footnote references keep their `id` and `aria-describedby` and back-references keep their `aria-label`:
|
|
208
271
|
|
|
209
272
|
```tsx
|
|
@@ -271,7 +334,8 @@ An open, unpinned popover closes on Escape while the focus is inside its menu, r
|
|
|
271
334
|
|
|
272
335
|
Activating an entry closes an unpinned table of contents, reveals the heading if it is hidden, scrolls to it (instantly under `prefers-reduced-motion: reduce`) and moves the focus to it (adding `tabindex="-1"` when the heading has none), so the next Tab continues from that section. Pass `onHeadingSelect(heading, event)` to take part: return `false` to let the viewer reveal, scroll and focus after your own work (writing the URL hash, say), or `true` when you have handled the navigation yourself.
|
|
273
336
|
|
|
274
|
-
|
|
337
|
+
The entry of a heading without an id (`# ★`, whose text keeps no character) is its text alone, not a link: no fragment names that heading, so neither `headingHref` nor `onHeadingSelect` is called for it.
|
|
338
|
+
Any other entry links to `#` followed by the heading's id. Where the page's URL does not address the document (several documents side by side, a document chosen by state), pass `headingHref(heading)` (`MarkdownHeadingHrefResolver`) to give each entry the heading's own address, so copying the entry's address or opening it in a new tab with a middle click reaches the heading; pass a stable function, since the table of contents is built again when it changes.
|
|
275
339
|
The href goes through the package's URL rule (an entry with a refused href has none), and activating an entry still runs `onHeadingSelect` and the viewer's navigation. A Ctrl-, Cmd- or Shift-click is an activation, so return `true` from `onHeadingSelect` when a modifier key is down to let the browser open the address instead.
|
|
276
340
|
|
|
277
341
|
The viewer stops the link's own navigation, so it reveals the heading the way a browser reveals the fragment it navigates to:
|
|
@@ -305,7 +369,7 @@ const headingHref: MarkdownHeadingHrefResolver = (heading) => `/docs/guide.md#${
|
|
|
305
369
|
|
|
306
370
|
Every name and text the viewer draws comes from `labels` (`MarkdownViewerLabels`), including the table-of-contents and alignment controls and, through the `mermaid*` keys, the controls of each Mermaid diagram (`MermaidDiagram` takes `MermaidDiagramLabels` as `labels`).
|
|
307
371
|
A label you pass carries no language of its own and is read in your page's language.
|
|
308
|
-
A built-in label marks the element that bears it with its own language: the status texts and style controls are English (`lang="en"`), the table-of-contents, alignment and Mermaid menu controls are Japanese (`lang="ja"`), and the Mermaid zoom buttons are English. `DEFAULT_MARKDOWN_VIEWER_LABELS` and `
|
|
372
|
+
A built-in label marks the element that bears it with its own language: the status texts and style controls are English (`lang="en"`), the table-of-contents, alignment and Mermaid menu controls are Japanese (`lang="ja"`), and the Mermaid zoom buttons are English. The embed labels (`embeddedVideo`, `embeddedPost`, `embeddedFrame`) are English. `DEFAULT_MARKDOWN_VIEWER_LABELS`, `DEFAULT_MERMAID_DIAGRAM_LABELS` and `DEFAULT_MARKDOWN_EMBED_LABELS` hold the built-in texts.
|
|
309
373
|
|
|
310
374
|
### Settings without React
|
|
311
375
|
|
|
@@ -319,6 +383,29 @@ import { DEFAULT_MARKDOWN_STYLES, toContentAlign } from "@aiquants/markdown/view
|
|
|
319
383
|
|
|
320
384
|
The parser supports the following extended markdown syntax in addition to CommonMark and GFM.
|
|
321
385
|
|
|
386
|
+
### Heading ids
|
|
387
|
+
|
|
388
|
+
The converter gives every heading its id; `MarkdownViewer` and `MarkdownRenderer` render the ids of the HTML and assign none.
|
|
389
|
+
|
|
390
|
+
- **Written id**: end the heading's last line with `{#id}`, or with `{id="…"}` when the id holds a space or ASCII punctuation other than `_`, `-`, `:` and `.` (a `}`, say). `## 概要 {#overview}` gets the id `overview`.
|
|
391
|
+
- It is kept exactly as written, in any script.
|
|
392
|
+
- No automatic id takes it, wherever the heading is.
|
|
393
|
+
- When two headings write the same id, both keep it and a fragment names the first.
|
|
394
|
+
- An id attribute that names nothing — empty (`{#}`, `{id=""}`) or not a string (`{id=123}`) — is removed, and the heading gets its automatic id.
|
|
395
|
+
- **Automatic id**: GitHub's, as github-slugger 2.0.0 makes it from the heading's text:
|
|
396
|
+
- lower-cased;
|
|
397
|
+
- punctuation and symbols removed;
|
|
398
|
+
- letters, marks, digits, `_` and `-` of every script kept;
|
|
399
|
+
- each space becomes `-`;
|
|
400
|
+
- a repeated id gets `-1`, `-2`, ….
|
|
401
|
+
- Examples: `概要` → `概要`, `API の使い方` → `api-の使い方`, `Step 2: Install` → `step-2-install`, a second `重複` → `重複-1`.
|
|
402
|
+
- A heading whose text keeps no character (`★`) has no id, its `ParseResult.headings[].id` is `""`, and its table-of-contents entry is plain text, not a link.
|
|
403
|
+
- The text is the heading's text as GitHub reads it: no Typographer substitution (`A -- B` → `a----b`), white space as written, an image's alt and raw HTML left out. The spaces and tabs before an ATX closing sequence or a `{…}` block are not text (`# Title ##` → `title`).
|
|
404
|
+
- Where the converter parses a construct differently from GitHub, the id follows the converter's rendering: `$ x $` (text here, a formula on GitHub), the number of a footnote referenced from inside another note, a code span continued on an indented line, `<<x>>`, Zenn directives and definition lists.
|
|
405
|
+
- **Anchors in raw HTML**: the viewer keeps `<a name="…">` and ids starting with `user-content-`. `<a id="user-content-faq"></a>` is reached by `#user-content-faq`. It removes any other author id (see [Raw HTML](#raw-html)).
|
|
406
|
+
|
|
407
|
+
Links written for GitHub or VS Code (`[概要へ](#概要)`, `[使い方](#api-の使い方)`) land on the heading.
|
|
408
|
+
|
|
322
409
|
### LaTeX Math Expressions
|
|
323
410
|
|
|
324
411
|
- Inline math: `$y=x^2$`. A single `$` follows the `tex_math_dollars` rule of Pandoc 3.12: the opening `$` must be followed by a character that is not white space, and the formula ends at the first `$` after it that is not escaped by `\` and not inside a `\text{…}` group whose braces close; that `$` must follow a character that is not white space (a character escaped by `\`, such as the space in `$a\ $`, is not) and must not be followed by an ASCII digit; otherwise the `$` stays text.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { g as p, r as u, d as a } from "./chunk-MOJQB5TN-
|
|
2
|
-
import { p as f } from "./chunk-JWPE2WC7-
|
|
3
|
-
import { _ as n,
|
|
1
|
+
import { g as p, r as u, d as a } from "./chunk-MOJQB5TN-CmOhW6SK.js";
|
|
2
|
+
import { p as f } from "./chunk-JWPE2WC7-CPLOunIL.js";
|
|
3
|
+
import { _ as n, O as o } from "./extractHeadings-B2pUyEPa.js";
|
|
4
4
|
import { M as c, b as d } from "./cynefin-VYW2F7L2-Bkk-F_Js.js";
|
|
5
5
|
var v = d().RailroadAbnf.parser.LangiumParser, i = /* @__PURE__ */ n((e) => {
|
|
6
6
|
const r = e.alternatives.map(g);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const a=require("./chunk-MOJQB5TN-
|
|
1
|
+
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const a=require("./chunk-MOJQB5TN-P8-yb3-j.cjs"),u=require("./chunk-JWPE2WC7-CUBzYD4G.cjs"),n=require("./extractHeadings-DgefF9l1.cjs"),i=require("./cynefin-VYW2F7L2-MpAliYy9.cjs");var p=i.createRailroadAbnfServices().RailroadAbnf.parser.LangiumParser,o=n.__name(e=>{const r=e.alternatives.map(c);return r.length===1?r[0]:{type:"choice",alternatives:r}},"transformAlternation"),c=n.__name(e=>{const r=e.elements.map(d);return r.length===1?r[0]:{type:"sequence",elements:r}},"transformConcatenation"),f=n.__name(e=>{if(e.includes("*")){const[t,s]=e.split("*"),l=t?parseInt(t,10):0,m=s?parseInt(s,10):1/0;return{min:l,max:m}}const r=parseInt(e,10);return{min:r,max:r}},"parseRepeat"),d=n.__name(e=>{const r=b(e.primary);if(!e.repeat)return r;const{min:t,max:s}=f(e.repeat);return t===0&&s===1?{type:"optional",element:r}:{type:"repetition",element:r,min:t,max:s}},"transformElement"),b=n.__name(e=>{switch(e.$type){case"AbnfStringLiteral":return{type:"terminal",value:e.value};case"AbnfNumVal":return{type:"terminal",value:e.value};case"AbnfRuleName":return{type:"nonterminal",name:e.name};case"AbnfGroup":return o(e.element);case"AbnfOptionalGroup":return{type:"optional",element:o(e.element)};default:throw new Error(`Unsupported ABNF primary node: ${e.$type}`)}},"transformPrimary"),g=n.__name(e=>({name:e.name,definition:o(e.definition)}),"transformRule"),v=n.__name(e=>{u.populateCommonDb(e,a.db),e.title&&a.db.setTitle(e.title),e.rules.map(r=>a.db.addRule(g(r)))},"populateDb"),y={parse:n.__name(e=>{a.db.clear(),n.log.debug("[ABNF Parser] Starting Langium parse");const r=p.parse(e);if(r.lexerErrors.length>0||r.parserErrors.length>0)throw new i.MermaidParseError(r);const t=r.value;n.log.debug("[ABNF Parser] Parsed rules:",t.rules.length),v(t),n.log.debug("[ABNF Parser] Parse complete")},"parse"),parser:{yy:a.db}},_={parser:y,db:a.db,renderer:a.renderer,styles:a.getStyles};exports.diagram=_;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
"use strict";const n=require("./extractHeadings-
|
|
1
|
+
"use strict";const n=require("./extractHeadings-DgefF9l1.cjs");function $(o){return o.innerRadius}function b(o){return o.outerRadius}function k(o){return o.startAngle}function _(o){return o.endAngle}function nn(o){return o&&o.padAngle}function en(o,x,D,P,h,v,S,s){var E=D-o,r=P-x,e=S-h,p=s-v,i=p*E-e*r;if(!(i*i<n.epsilon))return i=(e*(x-v)-p*(o-h))/i,[o+i*E,x+i*r]}function M(o,x,D,P,h,v,S){var s=o-D,E=x-P,r=(S?v:-v)/n.sqrt(s*s+E*E),e=r*E,p=-r*s,i=o+e,u=x+p,c=D+e,f=P+p,j=(i+c)/2,l=(u+f)/2,y=c-i,g=f-u,A=y*y+g*g,R=h-v,T=i*f-c*u,H=(g<0?-1:1)*n.sqrt(n.max(0,R*R*A-T*T)),I=(T*g-y*H)/A,O=(-T*y-g*H)/A,q=(T*g+y*H)/A,d=(-T*y+g*H)/A,m=I-j,a=O-l,t=q-j,z=d-l;return m*m+a*a>t*t+z*z&&(I=q,O=d),{cx:I,cy:O,x01:-e,y01:-p,x11:I*(h/R-1),y11:O*(h/R-1)}}function an(){var o=$,x=b,D=n.constant(0),P=null,h=k,v=_,S=nn,s=null,E=n.withPath(r);function r(){var e,p,i=+o.apply(this,arguments),u=+x.apply(this,arguments),c=h.apply(this,arguments)-n.halfPi,f=v.apply(this,arguments)-n.halfPi,j=n.abs(f-c),l=f>c;if(s||(s=e=E()),u<i&&(p=u,u=i,i=p),!(u>n.epsilon))s.moveTo(0,0);else if(j>n.tau-n.epsilon)s.moveTo(u*n.cos(c),u*n.sin(c)),s.arc(0,0,u,c,f,!l),i>n.epsilon&&(s.moveTo(i*n.cos(f),i*n.sin(f)),s.arc(0,0,i,f,c,l));else{var y=c,g=f,A=c,R=f,T=j,H=j,I=S.apply(this,arguments)/2,O=I>n.epsilon&&(P?+P.apply(this,arguments):n.sqrt(i*i+u*u)),q=n.min(n.abs(u-i)/2,+D.apply(this,arguments)),d=q,m=q,a,t;if(O>n.epsilon){var z=n.asin(O/i*n.sin(I)),F=n.asin(O/u*n.sin(I));(T-=z*2)>n.epsilon?(z*=l?1:-1,A+=z,R-=z):(T=0,A=R=(c+f)/2),(H-=F*2)>n.epsilon?(F*=l?1:-1,y+=F,g-=F):(H=0,y=g=(c+f)/2)}var B=u*n.cos(y),C=u*n.sin(y),G=i*n.cos(R),J=i*n.sin(R);if(q>n.epsilon){var K=u*n.cos(g),L=u*n.sin(g),N=i*n.cos(A),Q=i*n.sin(A),w;if(j<n.pi)if(w=en(B,C,N,Q,K,L,G,J)){var U=B-w[0],V=C-w[1],W=K-w[0],X=L-w[1],Y=1/n.sin(n.acos((U*W+V*X)/(n.sqrt(U*U+V*V)*n.sqrt(W*W+X*X)))/2),Z=n.sqrt(w[0]*w[0]+w[1]*w[1]);d=n.min(q,(i-Z)/(Y-1)),m=n.min(q,(u-Z)/(Y+1))}else d=m=0}H>n.epsilon?m>n.epsilon?(a=M(N,Q,B,C,u,m,l),t=M(K,L,G,J,u,m,l),s.moveTo(a.cx+a.x01,a.cy+a.y01),m<q?s.arc(a.cx,a.cy,m,n.atan2(a.y01,a.x01),n.atan2(t.y01,t.x01),!l):(s.arc(a.cx,a.cy,m,n.atan2(a.y01,a.x01),n.atan2(a.y11,a.x11),!l),s.arc(0,0,u,n.atan2(a.cy+a.y11,a.cx+a.x11),n.atan2(t.cy+t.y11,t.cx+t.x11),!l),s.arc(t.cx,t.cy,m,n.atan2(t.y11,t.x11),n.atan2(t.y01,t.x01),!l))):(s.moveTo(B,C),s.arc(0,0,u,y,g,!l)):s.moveTo(B,C),!(i>n.epsilon)||!(T>n.epsilon)?s.lineTo(G,J):d>n.epsilon?(a=M(G,J,K,L,i,-d,l),t=M(B,C,N,Q,i,-d,l),s.lineTo(a.cx+a.x01,a.cy+a.y01),d<q?s.arc(a.cx,a.cy,d,n.atan2(a.y01,a.x01),n.atan2(t.y01,t.x01),!l):(s.arc(a.cx,a.cy,d,n.atan2(a.y01,a.x01),n.atan2(a.y11,a.x11),!l),s.arc(0,0,i,n.atan2(a.cy+a.y11,a.cx+a.x11),n.atan2(t.cy+t.y11,t.cx+t.x11),l),s.arc(t.cx,t.cy,d,n.atan2(t.y11,t.x11),n.atan2(t.y01,t.x01),!l))):s.arc(0,0,i,R,A,l)}if(s.closePath(),e)return s=null,e+""||null}return r.centroid=function(){var e=(+o.apply(this,arguments)+ +x.apply(this,arguments))/2,p=(+h.apply(this,arguments)+ +v.apply(this,arguments))/2-n.pi/2;return[n.cos(p)*e,n.sin(p)*e]},r.innerRadius=function(e){return arguments.length?(o=typeof e=="function"?e:n.constant(+e),r):o},r.outerRadius=function(e){return arguments.length?(x=typeof e=="function"?e:n.constant(+e),r):x},r.cornerRadius=function(e){return arguments.length?(D=typeof e=="function"?e:n.constant(+e),r):D},r.padRadius=function(e){return arguments.length?(P=e==null?null:typeof e=="function"?e:n.constant(+e),r):P},r.startAngle=function(e){return arguments.length?(h=typeof e=="function"?e:n.constant(+e),r):h},r.endAngle=function(e){return arguments.length?(v=typeof e=="function"?e:n.constant(+e),r):v},r.padAngle=function(e){return arguments.length?(S=typeof e=="function"?e:n.constant(+e),r):S},r.context=function(e){return arguments.length?(s=e??null,r):s},r}exports.d3arc=an;
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
import { aC as ln, aD as an, aE as y, aF as tn, aG as M, aH as D, aI as _, aJ as un, aK as rn, aL as S, aM as o, aN as H, aO as sn, aP as on, aQ as fn } from "./extractHeadings-B2pUyEPa.js";
|
|
2
|
+
function cn(l) {
|
|
3
|
+
return l.innerRadius;
|
|
4
|
+
}
|
|
5
|
+
function yn(l) {
|
|
6
|
+
return l.outerRadius;
|
|
7
|
+
}
|
|
8
|
+
function gn(l) {
|
|
9
|
+
return l.startAngle;
|
|
10
|
+
}
|
|
11
|
+
function dn(l) {
|
|
12
|
+
return l.endAngle;
|
|
13
|
+
}
|
|
14
|
+
function mn(l) {
|
|
15
|
+
return l && l.padAngle;
|
|
16
|
+
}
|
|
17
|
+
function pn(l, h, O, E, v, A, J, a) {
|
|
18
|
+
var q = O - l, i = E - h, n = J - v, d = a - A, u = d * q - n * i;
|
|
19
|
+
if (!(u * u < y))
|
|
20
|
+
return u = (n * (h - A) - d * (l - v)) / u, [l + u * q, h + u * i];
|
|
21
|
+
}
|
|
22
|
+
function W(l, h, O, E, v, A, J) {
|
|
23
|
+
var a = l - O, q = h - E, i = (J ? A : -A) / S(a * a + q * q), n = i * q, d = -i * a, u = l + n, s = h + d, f = O + n, c = E + d, K = (u + f) / 2, t = (s + c) / 2, m = f - u, g = c - s, R = m * m + g * g, T = v - A, P = u * c - f * s, C = (g < 0 ? -1 : 1) * S(fn(0, T * T * R - P * P)), F = (P * g - m * C) / R, G = (-P * m - g * C) / R, w = (P * g + m * C) / R, p = (-P * m + g * C) / R, x = F - K, e = G - t, r = w - K, L = p - t;
|
|
24
|
+
return x * x + e * e > r * r + L * L && (F = w, G = p), {
|
|
25
|
+
cx: F,
|
|
26
|
+
cy: G,
|
|
27
|
+
x01: -n,
|
|
28
|
+
y01: -d,
|
|
29
|
+
x11: F * (v / T - 1),
|
|
30
|
+
y11: G * (v / T - 1)
|
|
31
|
+
};
|
|
32
|
+
}
|
|
33
|
+
function hn() {
|
|
34
|
+
var l = cn, h = yn, O = H(0), E = null, v = gn, A = dn, J = mn, a = null, q = ln(i);
|
|
35
|
+
function i() {
|
|
36
|
+
var n, d, u = +l.apply(this, arguments), s = +h.apply(this, arguments), f = v.apply(this, arguments) - an, c = A.apply(this, arguments) - an, K = un(c - f), t = c > f;
|
|
37
|
+
if (a || (a = n = q()), s < u && (d = s, s = u, u = d), !(s > y)) a.moveTo(0, 0);
|
|
38
|
+
else if (K > tn - y)
|
|
39
|
+
a.moveTo(s * M(f), s * D(f)), a.arc(0, 0, s, f, c, !t), u > y && (a.moveTo(u * M(c), u * D(c)), a.arc(0, 0, u, c, f, t));
|
|
40
|
+
else {
|
|
41
|
+
var m = f, g = c, R = f, T = c, P = K, C = K, F = J.apply(this, arguments) / 2, G = F > y && (E ? +E.apply(this, arguments) : S(u * u + s * s)), w = _(un(s - u) / 2, +O.apply(this, arguments)), p = w, x = w, e, r;
|
|
42
|
+
if (G > y) {
|
|
43
|
+
var L = sn(G / u * D(F)), j = sn(G / s * D(F));
|
|
44
|
+
(P -= L * 2) > y ? (L *= t ? 1 : -1, R += L, T -= L) : (P = 0, R = T = (f + c) / 2), (C -= j * 2) > y ? (j *= t ? 1 : -1, m += j, g -= j) : (C = 0, m = g = (f + c) / 2);
|
|
45
|
+
}
|
|
46
|
+
var N = s * M(m), Q = s * D(m), z = u * M(T), B = u * D(T);
|
|
47
|
+
if (w > y) {
|
|
48
|
+
var U = s * M(g), V = s * D(g), X = u * M(R), Y = u * D(R), I;
|
|
49
|
+
if (K < rn)
|
|
50
|
+
if (I = pn(N, Q, X, Y, U, V, z, B)) {
|
|
51
|
+
var Z = N - I[0], $ = Q - I[1], k = U - I[0], b = V - I[1], nn = 1 / D(on((Z * k + $ * b) / (S(Z * Z + $ * $) * S(k * k + b * b))) / 2), en = S(I[0] * I[0] + I[1] * I[1]);
|
|
52
|
+
p = _(w, (u - en) / (nn - 1)), x = _(w, (s - en) / (nn + 1));
|
|
53
|
+
} else
|
|
54
|
+
p = x = 0;
|
|
55
|
+
}
|
|
56
|
+
C > y ? x > y ? (e = W(X, Y, N, Q, s, x, t), r = W(U, V, z, B, s, x, t), a.moveTo(e.cx + e.x01, e.cy + e.y01), x < w ? a.arc(e.cx, e.cy, x, o(e.y01, e.x01), o(r.y01, r.x01), !t) : (a.arc(e.cx, e.cy, x, o(e.y01, e.x01), o(e.y11, e.x11), !t), a.arc(0, 0, s, o(e.cy + e.y11, e.cx + e.x11), o(r.cy + r.y11, r.cx + r.x11), !t), a.arc(r.cx, r.cy, x, o(r.y11, r.x11), o(r.y01, r.x01), !t))) : (a.moveTo(N, Q), a.arc(0, 0, s, m, g, !t)) : a.moveTo(N, Q), !(u > y) || !(P > y) ? a.lineTo(z, B) : p > y ? (e = W(z, B, U, V, u, -p, t), r = W(N, Q, X, Y, u, -p, t), a.lineTo(e.cx + e.x01, e.cy + e.y01), p < w ? a.arc(e.cx, e.cy, p, o(e.y01, e.x01), o(r.y01, r.x01), !t) : (a.arc(e.cx, e.cy, p, o(e.y01, e.x01), o(e.y11, e.x11), !t), a.arc(0, 0, u, o(e.cy + e.y11, e.cx + e.x11), o(r.cy + r.y11, r.cx + r.x11), t), a.arc(r.cx, r.cy, p, o(r.y11, r.x11), o(r.y01, r.x01), !t))) : a.arc(0, 0, u, T, R, t);
|
|
57
|
+
}
|
|
58
|
+
if (a.closePath(), n) return a = null, n + "" || null;
|
|
59
|
+
}
|
|
60
|
+
return i.centroid = function() {
|
|
61
|
+
var n = (+l.apply(this, arguments) + +h.apply(this, arguments)) / 2, d = (+v.apply(this, arguments) + +A.apply(this, arguments)) / 2 - rn / 2;
|
|
62
|
+
return [M(d) * n, D(d) * n];
|
|
63
|
+
}, i.innerRadius = function(n) {
|
|
64
|
+
return arguments.length ? (l = typeof n == "function" ? n : H(+n), i) : l;
|
|
65
|
+
}, i.outerRadius = function(n) {
|
|
66
|
+
return arguments.length ? (h = typeof n == "function" ? n : H(+n), i) : h;
|
|
67
|
+
}, i.cornerRadius = function(n) {
|
|
68
|
+
return arguments.length ? (O = typeof n == "function" ? n : H(+n), i) : O;
|
|
69
|
+
}, i.padRadius = function(n) {
|
|
70
|
+
return arguments.length ? (E = n == null ? null : typeof n == "function" ? n : H(+n), i) : E;
|
|
71
|
+
}, i.startAngle = function(n) {
|
|
72
|
+
return arguments.length ? (v = typeof n == "function" ? n : H(+n), i) : v;
|
|
73
|
+
}, i.endAngle = function(n) {
|
|
74
|
+
return arguments.length ? (A = typeof n == "function" ? n : H(+n), i) : A;
|
|
75
|
+
}, i.padAngle = function(n) {
|
|
76
|
+
return arguments.length ? (J = typeof n == "function" ? n : H(+n), i) : J;
|
|
77
|
+
}, i.context = function(n) {
|
|
78
|
+
return arguments.length ? (a = n ?? null, i) : a;
|
|
79
|
+
}, i;
|
|
80
|
+
}
|
|
81
|
+
export {
|
|
82
|
+
hn as d
|
|
83
|
+
};
|