npm 包 argdown-png-export 使用教程

Argdown-png-export是一款npm包,可以将Argdown语法的文件转换成png图片。Argdown是一种类似Markdown的语言,但专为argumentation mapping而设计。Argdown-png-export可以让开发者更好地使用Argdown语法,将其转化为图片,方便使用和分享。本篇文章将为大家详细介绍argdown-png-export的安装及使用方法,让大家能够快速上手。

安装

使用npm进行安装:

--- ------- ------------------

安装后,我们可以通过引用argdown-png-export来使用它的功能。

使用

  1. 引入依赖

在需要使用的文件中,引入ArgdownPngExport类,如下所示:

----- ---------------- - ------------------------------
  1. 创建实例

使用ArgdownPngExport类创建一个实例:

----- ---------------- - --- -------------------
  1. 转化Argdown文档为png图片

使用convert方法将Argdown文档转化为png图片:

-------------------------------- -------- ----------

其中,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


猜你喜欢

  • npm 包 content-type-middleware 使用教程

    在前端开发领域,我们常常需要对 HTTP 请求或响应中的 Content-Type 头字段进行处理。这种场景下,我们可以借助 npm 包 content-type-middleware,使用它可以轻松...

    3 年前
  • npm 包 getqh 使用教程

    简介 getqh 是一款可以轻松获取网页元素位置的 npm 包,它可以通过直接在代码中获取元素的位置信息,非常便于前端开发人员在编写网页时进行布局和定位。 安装 在使用 getqh 之前,需要先安装它...

    3 年前
  • NPM 包 Obj-to-String 使用教程

    在前端开发中,经常需要进行对象的序列化,将对象转换成字符串形式,以便传输、储存或展示。今天介绍一个方便快捷的 NPM 包:Obj-to-String。 什么是 Obj-to-String? Obj-t...

    3 年前
  • npm 包 post_hexlet-js_project-brain-games 使用教程

    在前端开发中,一个常见的问题就是需要编写一些小型的交互式应用程序。为避免重复造轮子,我们可以使用 npm 包来实现我们的功能。其中一个很流行的选择是 post_hexlet-js_project-br...

    3 年前
  • npm 包 vue-zxhuan-ui 使用教程

    在前端开发中,很多人喜欢使用现成的工具来提高开发效率和代码质量。本文将介绍一个非常好用的 npm 包——vue-zxhuan-ui,它是一个基于 Vue.js 的 UI 组件库,提供了丰富的 UI 组...

    3 年前
  • npm 包 lru-cache-node 使用教程

    前言 在前端开发中,我们常常需要处理大量的数据,而对于一些重复频率比较高的数据,每次都去请求服务器显然是不划算的。为了提高数据访问速度,我们可以使用 lru-cache-node 这个 npm 包来做...

    3 年前
  • npm 包 generator-ts-booster 使用教程

    前言 在前端开发中,我们经常需要用到构建工具来处理代码、打包、压缩等等。而 generator-ts-booster 是一个基于 Yeoman 的生成器,旨在帮助我们更快地搭建基于 TypeScrip...

    3 年前
  • npm 包 max31856 使用教程

    本文将介绍如何使用 npm 包 max31856 在前端页面中实现基于热电偶的温度测量功能。首先我们需要明确,max31856 是什么,它有什么作用? 一、max31856 简介 max31856 是...

    3 年前
  • npm包Supplychain使用教程

    简介 Supplychain是一款基于JavaScript的npm包,旨在为前端开发者提供简单而强大的供应链解决方案。该npm包封装了一系列常用的供应链功能,包括货物状态跟踪、交易历史记录、物流信息查...

    3 年前
  • npm 包 aqru 使用教程

    简介 aqru 是一个用于处理异步操作的 JavaScript 工具库,它提供了一些常用的异步控制流程方法,例如 waterfall 和 parallel 等。 安装 使用 npm 安装 aqru,执...

    3 年前
  • npm 包 video-scan-watch 使用教程

    简介 video-scan-watch 是一个 npm 包,其主要功能是实现视频的自动截图。该包是基于 FFMPEG 和 Node.js 开发的,并支持多种格式的音视频文件。

    3 年前
  • npm 包 redux-optimistic-thunk 使用教程

    前言 在 Web 开发中,前端作为用户与服务器之间的桥梁,对用户体验至关重要。Redux 是其中重要的数据管理框架,而 redux-optimistic-thunk 包则是为了解决并发问题而出现的。

    3 年前
  • npm 包 dicom-dimse 使用教程

    什么是 dicom-dimse? DICOM(Digital Imaging and Communications in Medicine)是一种医学图像和相关数据的标准通信协议。

    3 年前
  • npm 包 generator-wv 使用教程

    介绍 generator-wv 是一个使用 Yeoman 构建 Web 项目的脚手架生成器,可以自动化创建项目架构,并提供了使用 Sass、React 等技术栈的模板。

    3 年前
  • npm 包 samma 使用教程

    简介 samma 是一个用于前端单元测试的 npm 包,它使用 Mocha 和 Chai,提供了一套易于使用的 API 和测试环境配置。samma 的目标是减少编写和维护前端测试的工作量,从而提高代码...

    3 年前
  • npm 包 react-augment 使用教程

    简介 react-augment 是一个提供在 React 组件中混入行为的 npm 包。其最大的好处是可以给已有组件增加功能,而不会破坏其原有的实现。react-augment 提供了一个高阶函数 ...

    3 年前
  • npm 包 name-my-unicorn 使用教程

    前言 前端开发中经常要使用到各种 npm 包,而 name-my-unicorn 这个 npm 包可以让你为你的项目生成一个独一无二的、个性化的、有趣的项目名称。在技术项目中加入一些趣味性的元素是十分...

    3 年前
  • npm 包 @myfave/aws4-react-native 使用教程

    介绍 AWS4 是 Amazon Web Services (AWS) 提供的一种签名算法,用于对 AWS API 进行身份验证。而 @myfave/aws4-react-native 就是一个在 R...

    3 年前
  • npm 包 c0bancore-wallet-client 使用教程

    前言 c0bancore-wallet-client 是一个 Node.js 的 npm 包,提供方便的交互方式,可以通过其进行账户创建、转账等操作。该包基于 c0bancoin-core 库实现,需...

    3 年前
  • npm 包 easydav-jqput-pmb 使用教程

    前言 在前端开发中,与后端交互是必不可少的,而 WebDAV 协议是一种常见的开发 API 的方式,在 Node.js 环境下可以使用 easydav-jqput-pmb 这个 npm 包来访问 We...

    3 年前

相关推荐

    暂无文章