本文主要介绍 npm 包 wiki-plugin-wikish 的使用教程。为了避免一些人可能不了解 markdown 的语法，本文将采用简洁明了的语言和示例代码来讲解，让大家更加轻松愉快的学习和掌握该技术。
前言
在前端开发的过程中，我们难免会遇到需要使用到类似于百度百科的知识库的情况，这时候，如果我们能使用 wiki-plugin-wikish 这个 npm 包，将减少开发所需要的时间和成本，提高我们的开发效率。
wiki-plugin-wikish 是什么？
wiki-plugin-wikish 是一个将 markdown 文本转化为带有 wiki 风格的 HTML 标签及实现左侧导航的 npm 包。
安装
在安装 wiki-plugin-wikish 的时候，我们需要先将该 npm 包下载到本地。
npm install --save-dev wiki-plugin-wikish
如果你在 npm 包管理器中搜索不到该包，可以使用以下命令：
npm install --registry https://registry.npm.taobao.org/wiki-plugin-wikish
使用
使用 wiki-plugin-wikish 有两种方式，第一种是使用命令行，第二种是使用 JavaScript。
命令行
在命令行中使用 wiki-plugin-wikish 的方式是将 markdown 文件转化为 HTML。
wikish README.md README.html
以上命令将 README.md 转化为带有 wiki 风格的 HTML 文件 README.html。
JavaScript
在 JavaScript 中使用 wiki-plugin-wikish 的方式是将 markdown 文本转化为带有 wiki 风格的 HTML 标签及实现左侧导航。
-- -------------------- ---- ------- ----- ------ - ------------------------------ ----- -------- - - - ---- -- ---- ------------- -- ---- - --- - --- - --- -- ----- ---- - ----------------- ------------------
以上代码将 markdown 文本转化为带有 wiki 风格的 HTML 标签及实现左侧导航。
参数
在使用 wiki-plugin-wikish 的时候，我们还可以添加参数去实现可自定义化。
-- -------------------- ---- -------
----- ------ - ------------------------------
----- -------- - -
- ----
-- ----
-------------
-- ----
- ---
- ---
- ---
--
----- ------- - -
--- -------
------ -------
------- -------
--
----- ---- - ---------------- ---------
------------------以上代码中，我们添加了一个 options 参数，可以用来实现可自定义化，其中：id 表示为 HTML 标签的 ID，width 表示为宽度，height 表示为高度。
结束语
至此，我们已经了解了 wiki-plugin-wikish 的使用教程。相信通过本文的学习，你已经掌握了这一技术，并且可以在实际的开发中运用到。谢谢大家的阅读！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/wiki-plugin-wikish