npm 包 codemirror-markdown-list-autoindent 使用教程

阅读时长 4 分钟读完

介绍

npm 包 codemirror-markdown-list-autoindent 可以让使用 CodeMirror 编辑器的 Markdown 文本自动缩进。当用户在文本编辑区中输入了列表标记符号 "-", "*", "1.", "2.", "3." 等,会在下一行自动缩进。这个功能在 Markdown 编辑器中非常常见,使用它可以让你的 Markdown 文本保持整洁和易读性。

该 npm 包基于 CodeMirror 编辑器和 Markdown 语法解析器,并提供了一个简单易用的 API。

安装

可以通过 npm 安装该包:

或者,也可以通过 script 标签引入:

使用

首先在 HTML 中创建一个文本编辑区:

然后在 JavaScript 中初始化 CodeMirror 编辑器,并调用 codemirror-markdown-list-autoindent 包提供的 API:

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

这样就可以让 CodeMirror 编辑器支持 Markdown 自动缩进了。

示例代码

这是一个完整的使用示例代码,包括了一个 HTML 文件和对应的 JavaScript 文件:

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

使用该示例代码创建一个 HTML 文件,用浏览器打开该文件,即可看到一个支持 Markdown 缩进的 CodeMirror 编辑器。

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

纠错
反馈