Argdown-png-export是一款npm包,可以将Argdown语法的文件转换成png图片。Argdown是一种类似Markdown的语言,但专为argumentation mapping而设计。Argdown-png-export可以让开发者更好地使用Argdown语法,将其转化为图片,方便使用和分享。本篇文章将为大家详细介绍argdown-png-export的安装及使用方法,让大家能够快速上手。
安装
使用npm进行安装:
npm install argdown-png-export
安装后,我们可以通过引用argdown-png-export来使用它的功能。
使用
- 引入依赖
在需要使用的文件中,引入ArgdownPngExport类,如下所示:
const ArgdownPngExport = require('argdown-png-export');
- 创建实例
使用ArgdownPngExport类创建一个实例:
const argdownPngExport = new ArgdownPngExport();
- 转化Argdown文档为png图片
使用convert方法将Argdown文档转化为png图片:
argdownPngExport.convert(source, options, callback);
其中,source为Argdown语法字符串,options为可选参数,可以设置图片大小等,callback则是转化成功后的回调函数。
-- -------------------- ---- ------- ----- ------ - - --- ------ --------- ------- ---- --- ----- --------- --- ----- ----- ---- -- ---- ----- ----- ----- -- ---- ----- ---- ---- ------------ --------- --- ------- ---- ---- - --- ------- -- ----- ------- - - ------ ---- ------- --- -- ----- -------- - ----------------------- -------------------------------- -------- ------------- ------- - -- ----- - ----------------- - ---- - -------------------------- -------- - ---
运行上述代码,会将source中的Argdown文档转化为200x200大小的png图片,并保存到output文件夹下的argdown.png中。
可选参数
ArgdownPngExport类中可用的可选参数如下:
- width: 图片宽度
- height: 图片高度
- backgroundColor: 背景颜色(默认为白色,可以通过传入十六进制颜色值来设置)
结语
Argdown-png-export作为一款方便转化Argdown文件为png图片的npm包,对于对argumentation mapping有需求的开发者来说十分实用。本文通过详细介绍其的安装及使用方法,并提供了示例代码,相信大家已经对Argdown-png-export有了更深入的了解。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60057cda81e8991b448ec093