npm 包 marking-mobile-frontend 使用教程

阅读时长 4 分钟读完

前言

现在的 Web 开发越来越注重移动端的体验,而前端框架也越来越丰富。它们的出现改变了我们的开发方式,提高了开发效率。而在前端开发中,我们经常会用到 markdown 来编辑文本,将其快速转化为网页上的内容。在移动端上,我们更希望使用一些移动化的解决方案来优化用户体验。这时,npm 包 marking-mobile-frontend 就来了。它能够让我们在移动端上更优雅地渲染 markdown 。

安装

首先,你需要在你的项目目录下进行 npm 包的安装。

使用

安装完成后,我们需要在代码中引用它,然后初始化。

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

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

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

初始化后即可开始渲染 markdown 文件。渲染结果的样式类似于在移动端上使用富文本编辑器的效果。

配置项

使用 marking-mobile-frontend 的过程中,我们可以对 MarkingMobileFrontend 构造函数的参数进行配置。

el

这个参数就是渲染 markdown 时的容器元素选择器。

markdown

这个参数是一段 markdown 文件的字符串,即需渲染的 markdown 内容。

converter

这个参数是用于将 markdown 文件转化为 html 格式的转换器,默认为 markdown-js。

onRendered

这个参数是当渲染完成后的回调函数,会返回当前渲染结果的 html 代码。

示例

以下是一个简单的示例:

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

总结

使用 marking-mobile-frontend 能够让我们在移动端上更方便、快速地渲染 markdown 文件,提升用户体验。希望本篇技术文章能对你有所启发。

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

纠错
反馈