npm 包 @koara/koara 使用教程

阅读时长 4 分钟读完

介绍

@koara/koara 是一个为前端开发者提供的 MarkDown 模块,支持实时的编辑预览和导出,也可以嵌入 MarkDown 编辑器中进行使用。

安装

在使用 @koara/koara 之前需要先安装 Node.js 环境,具体步骤如下:

  1. 在官网 https://nodejs.org/zh-cn/ 下载对应的 Node.js 安装文件,并完成安装。
  2. 打开终端(Mac/Linux)或命令行(Windows),输入 node -v 命令,查看 Node.js 是否安装成功。
  3. 在终端或命令行中输入 npm install -g @koara/koara 命令,安装 @koara/koara 包。

使用

实时编辑预览

在使用 @koara/koara 进行实时编辑预览之前,需要创建一个 HTML 文件,并引入搭建好的 MarkDown 编辑器。具体步骤如下:

  1. 创建HTML文件(如 demo.html)。
  2. 在 HTML 文件中引入 @koara/koara 相关的样式和脚本文件,具体代码如下:
-- -------------------- ---- -------
--------- -----
------
------
  ----- ----------------
  -------------------
  ----- ---------------- -------------------------------------------------- --
  -------
    ------- -
      ------- ---------- - ------
    -
  --------
-------
------
  ---- ------------------
  ------- ----------------------------------------------------------
  --------
    ------------------------
  ---------
-------
-------
  1. 在终端或命令行中进入 HTML 文件所在目录,并输入 koara serve 命令,启动本地服务器。
  2. 打开浏览器并输入 http://localhost:3000/demo.html,即可实现 MarkDown 编辑器的实时预览。

导出 MarkDown 文件

在编辑 MarkDown 文本时,我们需要将其导出到本地进行查看和修改。具体步骤如下:

  1. 在 MarkDown 编辑器中,点击导出按钮。
  2. 在弹窗中选择所需导出的文件格式和保存路径。
  3. 点击保存按钮,即可将 MarkDown 文件导出到本地。

示例代码

下面是一个简单的应用示例,展示了如何在 HTML 页面中集成 @koara/koara,以及如何导出 MarkDown 文件。

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

在 HTML 文件中,我们创建了一个导出按钮,并为其绑定了一个点击事件。当用户点击该按钮时,我们将使用 editor.getText() 方法以获取当前 MarkDown 编辑器中的文本内容,并使用 FileSaver.js 库中的 saveAs() 方法将文本内容保存到本地。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60055cdd81e8991b448da7d1

纠错
反馈