npm 包 namuwiki 使用教程

介绍

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


猜你喜欢

  • npm 包 canvas-sketchpad 使用教程

    在前端开发中,我们经常需要涉及到绘图和图像处理,而canvas技术是其中应用最广泛的技术之一。而 npm 包 canvas-sketchpad 可以帮助我们快速搭建一个简单的画板,可以方便地进行绘图和...

    3 年前
  • npm 包 wink-regression-tree 使用教程

    简介 wink-regression-tree 是一款用于生成决策树回归模型的 npm 包。它基于 JavaScript 实现,可以在 Node.js 环境下使用,并提供了大量的 API 接口,可供开...

    3 年前
  • npm 包 bootstrap-cookie-consent 使用教程

    前言 在前端开发中,我们经常会涉及到处理 Cookie 的场景,例如用户登录、浏览器记住登录状态、记录用户浏览行为等等。为了更好地处理 Cookie,我们需要使用一些 Cookie 处理工具。

    3 年前
  • npm 包 concise-readableformatter 使用教程

    在前端开发过程中,我们经常需要对代码进行格式化,以保证其读取性和可维护性。而 concise-readableformatter 就是一款非常优秀的 npm 包,它可以极大地提升代码的可读性,让代码更...

    3 年前
  • npm 包 react-horizontal-switch-scroll 使用教程

    在前端开发中,常常需要使用到滚动条来控制某些组件的显示。但是一些普通的滚动条可能无法满足我们的需求,这时候就需要使用一些比较专业的 npm 包来实现更加高级的滚动效果。

    3 年前
  • npm 包 search-algorithms 使用教程

    搜索算法是计算机科学中的重要算法之一,它有着广泛的应用。在前端开发中,搜索算法也有一定的应用场景。npm 包 search-algorithms 是一个实现了多种搜索算法的 JavaScript 库,...

    3 年前
  • npm 包 callbag-loop 使用教程

    什么是 callbag-loop callbag-loop 是一个 npm 包,它提供了一种新的响应式编程范式,用于管理 JavaScript 应用程序的状态和副作用。

    3 年前
  • npm 包 objection-events 使用教程

    简介 Objection.js 是一个基于 Node.js 的 ORM 库,可以方便地与各种关系型数据库进行交互。而 objection-events 则是一个为 Objection.js 提供事件支...

    3 年前
  • npm 包 Vue-cli-plugin-boardgame 使用教程

    在前端开发中,使用 Vue.js 可以方便地构建现代化的应用程序。而 Vue CLI 提供了更加便捷的工具来开发和维护 Vue 应用。对于需要开发棋牌类游戏的开发者来说,Vue-cli-plugin-...

    3 年前
  • npm 包 first-officer 使用教程

    前言 随着前端技术的不断发展,前端开发对于工具的依赖越来越高。其中,npm 作为前端生态中的重要组成部分,扮演了非常重要的角色。而 first-officer 就是一个依赖于 npm 的包,可用于构建...

    3 年前
  • npm 包 vr-visualization 使用教程

    前言 虚拟现实已经成为了当今科技领域的热点话题,而虚拟现实的可视化技术也同样备受关注。在前端技术中,通过使用 npm 包 vr-visualization,我们可以利用 web 技术创建基于虚拟现实交...

    3 年前
  • npm 包 generator-tinyspa 使用教程

    在前端开发中,使用代码生成器能够高效地加速开发速度。generator-tinyspa 是一个npm包,可以用于自动生成基于 React 或者 Vue 的单页面应用(SPA)。

    3 年前
  • npm 包 q-core-ui-components 使用教程

    在前端开发中,UI 组件库是必不可少的。其中,q-core-ui-components 是一个由 Qihoo 360 前端团队开发的 UI 组件库,已经被广泛应用于各种网站和应用的开发中。

    3 年前
  • npm 包 react-datetime-slider-picker 使用教程

    react-datetime-slider-picker 是一款使用方便的 React 时间选择器,它可以让用户使用滑动条和下拉框方便地选择日期和时间。该包适用于各种 Web 开发和 React 项目...

    3 年前
  • npm 包 gatsby-source-strapi-localized 使用教程

    简介 gatsby-source-strapi-localized 是一个适用于 GatsbyJS 的 npm 包,它允许你将 Strapi 管理的本地化内容源导入到你的 Gatsby 网站中。

    3 年前
  • npm 包 react-native-view-global-redux 使用教程

    前言 React Native 是一种基于 JavaScript 和 React 的应用开发框架,允许开发者使用类似于网页开发的方式创建本地应用程序。而 React Native View Globa...

    3 年前
  • npm 包 celeb-diwali 使用教程

    介绍 celeb-diwali 是一个可以用于在你的网页或移动应用中添加“Diwali”(印度教的节日)效果的 npm 包。它提供了丰富的选项,可以自定义颜色、粒子数量、动画速度等,同时还支持在代码中...

    3 年前
  • npm 包 backaid 使用教程

    什么是 backaid backaid 是一个可以帮助开发者在前端应用中轻松设置和使用后端接口的 npm 包。它可以帮助开发者避免重复编写类似的网络请求代码,提高开发效率。

    3 年前
  • npm 包 vegas-js-events 使用教程

    介绍 vegas-js-events 是一个基于 jQuery 的事件库,提供了一种舞台方式来实现事件的播放。它允许在具有先决条件的情况下触发多个事件。本文将介绍如何使用该包及其 API,以及示例代码...

    3 年前
  • npm 包 long-task-requester 使用教程

    在前端开发过程中,有时我们需要处理长时间运行的任务,如图像处理、视频转换等。这些任务可能会占用大量的时间和计算资源,而且会影响用户体验。因此,我们需要一种方法来让这些任务在后台运行,并可控。

    3 年前

相关推荐

    暂无文章