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 包 @sheetbase/tamotsux-server 使用教程

    @sheetbase/tamotsux-server 是一个基于 Node.js 的 ORM 封装库,可以帮助开发者快速实现对数据库的 CURD 操作,支持多种主流数据库,比如 MySQL、Postg...

    3 年前
  • npm 包 messageevent-stream 使用教程

    简介 messageevent-stream 是一个 npm 包,它可以将事件转换为流并进行处理。该包可用于前端和后端开发中,可以帮助我们更好地管理事件。在前端开发中,我们可以使用它来实现各种事件处理...

    3 年前
  • npm 包 @webdav-server/dropbox 使用教程

    介绍 @webdav-server/dropbox 是一个基于 Node.js 的 npm 包,可以实现在前端中使用 Dropbox 进行文件上传、下载、管理等操作。

    3 年前
  • npm 包 ww-vue-hotel-datepicker 使用教程

    ww-vue-hotel-datepicker 是一款基于 Vue.js 的日期选择器,特别适用于酒店预定场景。该组件支持多种语言,以及选择入住时间和离店时间,还支持动态设置可用日期范围等功能。

    3 年前
  • npm 包 @astro-my/npdynamodb 使用教程

    简介 在前端开发中,我们经常需要使用数据库来存储和管理数据。DynamoDB 是一种 NoSQL 数据库,它可以在 Amazon Web Services 上使用。

    3 年前
  • NPM 包 @fabiospampinato/lockable 使用教程

    简介 @fabiospampinato/lockable 是一个可以加锁的 JavaScript 对象,它可以将一个键值对暂时锁定,这样可以避免在特定的情况下被修改或删除。

    3 年前
  • NPM 包 activable 使用教程

    在前端开发中,我们经常需要为页面的某些元素增加交互效果,比如 hover、click 等。activable 是一个简单易用的 NPM 包,可以帮助我们快速实现这些交互效果。

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

    GraphQL 是一种由 Facebook 开发的 API 查询语言。它让客户端可以明确地调用出所需要的数据,并且可以将多个数据请求合并到单个请求中,从而大大提高了性能。

    3 年前
  • npm 包"@fabiospampinato/event-emitter" 使用教程

    简介 "@fabiospampinato/event-emitter" 是一个 Node.js 包,实现了标准 EventEmitter 接口,并提供许多附加功能,如命名空间、异步事件处理、触发器后续...

    3 年前
  • npm 包 @fabiospampinato/fifo 使用教程

    npm 包 @fabiospampinato/fifo 使用教程 1. 什么是 @fabiospampinato/fifo @fabiospampinato/fifo 是一个针对 Javascript...

    3 年前
  • 使用教程:npm 包 htmlelement-animation

    使用教程:npm 包 htmlelement-animation 当今,动画已经成为了网站设计必不可少的一部分,而 htmlelement-animation npm 包则是一个简单易用的动画库。

    3 年前
  • npm 包 @dwarvesf/tailwind-plugins 使用教程

    简介 @dwavesf/tailwind-plugins 是一款基于 Tailwind CSS 的插件,允许快速创建常用的 UI 组件,在日常的前端开发中极为实用。

    3 年前
  • npm 包 sparkline.js 使用教程

    随着 Web 界面的日益复杂,需要更强大的界面交互效果去提升用户的体验。在数据可视化的领域中,小而美的 sparkline 图表(小型折线图)是一种非常受欢迎的作法,能够展示紧凑、简洁的数据趋势,适用...

    3 年前
  • NPM 包 rehype-sectionize-headings 使用教程

    前言 在前端开发中,HTML 经常是开发者们需要操作的一项技术。而随着项目规模的不断增大,HTML 中的一些细节问题就变得十分重要。这时候,使用一些帮助我们更好地操作 HTML 的工具就非常必要了。

    3 年前
  • npm 包 @beefoio/file.log 使用教程

    在前端开发中,我们会经常需要将应用程序的日志信息记录到文件中,以便于后续排查问题。而使用 npm 包 @beefoio/file.log 则可以简化这一过程。 安装 在项目根目录下使用 npm 安装 ...

    3 年前
  • npm 包 @kelcon/homebridge-zwave-direct 使用教程

    在前端工程师的日常工作中,引入外部库和第三方依赖非常常见。其中,npm 包是前端开发中使用最多的工具之一。本文将详细介绍一个叫做 @kelcon/homebridge-zwave-direct 的 n...

    3 年前
  • npm包 @psoltys/remarker使用教程

    在前端开发中,我们经常需要创建文档或演示文稿,这时用到一个好的Markdown解析器就非常重要。本篇文章介绍了一个优秀的npm包 @psoltys/remarker,它可以将Markdown格式的文档...

    3 年前
  • npm 包 @unibtc/theia-vue-extension 使用教程

    在前端开发中,Vue.js 是一种广泛使用的 JavaScript 框架之一。在使用 Vue.js 开发应用程序时,很多情况下我们需要使用一些插件来简化开发工作流程。

    3 年前
  • npm 包 codex.editor.warning 使用教程

    在前端开发中,我们经常需要进行代码检查以确保代码质量和可读性。而 codex.editor.warning 正是一个非常强大的 npm 包,它可以帮助我们对代码进行自动化的检查,以提高编程能力和效率。

    3 年前
  • npm 包 react-decent-virtualization 使用教程

    简介 react-decent-virtualization 是一款基于 React 的可视化组件库,适用于大数据量的展示和滚动操作。它基于虚拟化技术实现了高效的渲染和滚动体验,减少了对内存和性能的消...

    3 年前

相关推荐

    暂无文章