npm包outliner-5000使用教程

阅读时长 4 分钟读完

介绍

outliner-5000是一个基于Node.jsnpm包,可以将HTML文档中的标题分级展示,让用户更清晰地了解文档的结构,增加阅读体验。

安装

使用npm进行安装,运行以下命令即可:

使用

1. 加载模块

outliner-5000模块加载到你的应用程序中。

2. 准备HTML文档

在将HTML文档传递给outliner-5000之前,需要确保文档中的标题使用了<h1><h6>中的其中一个标签进行定义。例如:

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

3. 调用outliner()函数

将HTML文档传递给outliner()函数,获取展示分级后的文档。

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

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

以上代码中,我们使用marked将HTML文档转换成了Markdown格式,使用outliner-5000获取文档的分级信息,并将结果保存到新的HTML文档中。

4. 查看展示分级后的HTML文档

打开./document.outline.html文件,就可以看到分级展示后的HTML文档了。

示例代码

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

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

总结

outliner-5000使得HTML文档的分级显示变得更加方便。通过本篇文章中的简单介绍和示例代码,读者可以学习到如何使用outliner-5000展示分级后的HTML文档,并且也可以经过相关改造实现更多的独特的功能。

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

纠错
反馈