小书匠远程图片与xsjimg语法详解

需积分: 0 0 下载量 13 浏览量 更新于2024-08-05 收藏 193KB PDF 举报
"小书匠语法说明之远程图片1" 这篇文档主要介绍了小书匠编辑器中的一个特色语法——远程图片语法,该语法允许用户在编辑器中展示由特定服务动态生成的图片,比如Gravizo。这个功能并非是常见的markdown(Commonmark)标准,而是小书匠编辑器特有的扩展功能。 **概述** 远程图片语法的目的是将代码段中的文字转换为`<img>`标签,用于显示支持动态生成图片的服务生成的图像。例如,它可以用来在小书匠编辑器中展示Gravizo生成的图表。此功能的实现是小书匠对markdown语法的扩展,它不被其他通用的markdown解析器所支持。 **使用** 要启用远程图片语法,用户需要在设置中开启“扩展语法”的xsjimg选项,或者在每篇文章的元数据中通过`grammar_xsjimg`进行单独控制。默认情况下,这个功能是关闭的。 **参数设置** 1. **服务器地址(url)**:支持的变量为`xsjimg`,示例服务器地址是`https://g.gravizo.com/svg?{{xsjimg}}`。这意味着你需要将生成的代码替换到这个URL中的`{{xsjimg}}`位置,以便服务能够解析并生成对应的图像。 2. **参数编码方式(encode)**:提供了三种编码类型: - **default**:使用`encodeURIComponent`对原始内容进行编码,并将编码后的结果放入服务器地址的`xsjimg`变量中。 - **base64**:先用`encodeURIComponent`编码,再用`btoa`函数转换为Base64编码,然后替换到`xsjimg`变量。 - **zip**:使用压缩算法对原始内容进行压缩,然后将编码后的结果放入`xsjimg`变量。 **代码块参数** `xsjimg`语法还支持在代码块内修改参数,比如自定义`url`或`encode`参数。但要注意,这些参数的值必须经过`encodeURIComponent`编码。这样可以使得特定代码块使用不同的URL参数,而不会影响全局设置。 **支持xsjimg语法的相关网站服务** - **Gravizo**:提供了一个简单易用的图形语言,用于绘制UML图和其他类型的图表,其网址为`http://gravizo.com/`。 - **texs2cms**:可能是一个支持LaTeX语法生成图表的服务,文档中没有详细介绍。 **预览效果** 文档中提到了使用不同服务和编码方式的示例以及预览效果,但具体内容未在摘要中给出。用户可以通过实际操作或查阅完整文档来查看这些示例的详细效果。 小书匠的远程图片语法为用户提供了在编辑器中方便地插入和展示动态生成的图表的能力,特别适合需要在文本中插入复杂图形的场景,如技术文档、教程或报告。通过自定义参数,用户可以根据需要调整生成图像的方式和服务器。