什么是markdown-it-codesandbox?
markdown-it-codesandbox 是一个 markdown-it
插件,用于将示例代码块转换为SandBox,方便快速地测试代码并查看效果。通过使用这个插件,读者不仅可以更好地理解技术文章中的示例代码,还可以直接运行并编辑代码,以快速实践所学。
安装和使用markdown-it-codesandbox
首先,你需要安装 markdown-it
和 markdown-it-codesandbox
,在命令行中执行以下代码:
--- ------- ----------- ----------------------- ----------
接下来,在你的代码中使用它们,可以参考下面的JS代码:
----- ---------- - ---------------------- ----- ----------------- - ---------------------------------- ----- -- - --- ------------ ------------------------- ----- ---------- - -------------------------
以上代码中, markdownString
是你所需要转换的Markdown字符串。使用 markdown-it-codesandbox
插件将代码块转换为SandBox的方法非常简单:在代码块的开头,添加 codesandbox
标签。
-------------- -- -----------
---- ---------- ----- ------------------ ------------------------------------- ------------------- --------------------------------------- --------- ------------------ --------------------------- ----------- ----------------- ---------------------------------------------------- -------- ------ -------- ------- ------- ----------------------
使用示例
假设你有一个可以组合两个数字的 add
函数。你可以使用以下Markdown代码来描述这个函数:
- --- --- ------- -------------------- -------------- -------- ------ -- - ------ - - - -
--------------------------------------------- -- -- ------------------------ --------------------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------ ---------- -----------------------------------------------------------------------------------------------------------------------------