小书匠语法说明之codeChunk1
codeChunk 语法是小书匠语法的一种，主要用来执行代码块中的代码。该语法的特点主要受 rmarkdown 和 markdown-preview-enhanced 的启发，代码实现上主要参考了 markdown-preview-enhanced。主要用途就是实现直接执行代码块内的代码。目前该功能只能通过客户端实现。代码的执行受到操作系统、软件版本等多种因素的限制。
codeChunk 语法的主要参数包括：
* lang：代码块内的语言，用于代码高亮。如果 cmd 参数没有指定，则默认使用这个 lang 作为 cmd 来执行。
* cmd：代码块被执行时使用的命令，不同的操作系统会不同。例如，想要列出当前用户主目录下的文件，可以这样执行。
* line_number/linenums：用于代码高亮时是否显示行号，如果是具体数字，表示从指定行号开始。
* first_line：代码高亮时指定行号起始值。
* fancy：指定具体哪些行可以被高亮显示，多行用逗号分开。
* hide：是否隐藏代码高亮。如果是隐藏代码高亮，代码块将会被直接执行。注意：出于安全考虑，如果用户没有在全局打开非安全模式，该参数将失效。
* auto：是否自动执行代码块。注意：出于安全考虑，如果用户没有在全局打开非安全模式，该参数将失效。
* title：代码高亮时显示的标题，隐藏代码块时，该参数失效。
* output：执行完代码块后，返回给小书匠系统的输出格式。目前支持 html, png, none, 及不填 html 返回 html 代码块 png 返回 base64 格式的图片 none 无返回，隐藏输出结果 text 返回命令行的输出结果不填 返回命令行的输出结果
* args：args 参数可以追加自定义的参数。
* stdin：true 或者 false， 为true时，表示将代码块里的内容做为命令行输入，否则通过临时文件输入。
使用 codeChunk 语法需要注意以下几点：
* codeChunk 语法会执行代码段里的代码，存在被恶意代码段的风险，不要在不了解的情况下轻意指来历不明的代码块。
* 系统默认处在安全模式下，想打开非安全模式，可以到关于界面里设置为非安全。考虑到安全原因，用户下次再打开小书匠时，该设置将会被重置。
* 在导出时，系统只会导出用户手动执行过的代码段。想要让系统导出未执行过的代码段，需要用户打开非安全模式。
codeChunk 语法是一种强大的语法，可以帮助用户快速执行代码块中的代码，但同时也需要用户注意安全问题。
评论0