npm 包 namuwiki 使用教程

阅读时长 4 分钟读完

介绍

Namuwiki 是一个即时翻译并灵活解读 Markdown 语法的 Wiki 系统。其核心开发者通过 Naver 搜索引擎的资金支持,致力于创造一款快速、灵活、易用且强大的 Wiki 系统。

该系统实现了 Markdown 组合、流程图、表情符号、页内跳转、Ajax 翻页、图像热键、语法高亮、即时搜索、按键静音、公共讨论等多种功能。以 Markdown 为基础、遵循 HTML5 规范开发,能够兼容大部分主流浏览器。

npm 包 namuwiki 提供了使用 Namuwiki 编辑器和渲染器的方法和工具,让开发者可以方便地在自己的项目中使用 Namuwiki 的功能。

安装

您可以通过 npm 安装 namuwiki:

使用

文件引入

你可以直接在文件中引入该模块:

编辑器

Namuwiki 编辑器是支持 Markdown 语法的富文本编辑器,你可以使用它来编辑你的文档。

上述代码中 editor 是在 HTML 页面中的 <div> 元素,它将被转换为编辑器。autoFocus, minHeight, languageallowEmoji 是一些配置选项,你可以根据你的需求进行配置。

渲染器

Namuwiki 渲染器可以将您的文档转换为 HTML。

以上代码中 content 是文档内容,它来自于编辑器。html 是将 Markdown 转换为的 HTML。

第三方使用

如果您的项目是非 JavaScript 项目,则应该使用 Namuwiki 的 CDN 导入 Namuwiki:

可以使用全局变量 namuwiki 访问 Namuwiki 编辑器和渲染器:

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

结语

在使用 Namuwiki 编辑器和渲染器时,请仔细阅读官方文档。他提供了更详细的配置和用法说明,可以帮助你更好地使用这些工具。

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

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

纠错
反馈