npm包 gollum-nocinema 使用教程

阅读时长 3 分钟读完

简介

gollum-nocinema 是一个基于gollum的插件,可以为gollum wiki提供清晰的界面让用户进行阅读和编辑。本文将介绍如何使用该npm包。

安装

使用npm安装gollum-nocinema,只需要执行以下命令即可:

使用

引入gollum-nocinema

在使用gollum-nocinema前,需要先引入该模块。在Node.js应用中,可以通过以下方式引入:

初始化

在初始化gollum-nocinema时,需要传入gollum的实例、wiki所使用的配置文件以及一个回调函数。

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

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

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

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

使用gollum-nocinema

使用完成初始化后,即可使用gollum-nocinema提供的功能。gollum-nocinema提供了以下几个功能:

添加清晰的界面

支持Markdown语法

支持图片上传

界面优化

示例代码

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

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

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

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

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

总结

本文介绍了如何安装和使用gollum-nocinema生成清晰的gollum wiki界面。gollum-nocinema提供了多项功能,可根据具体需求使用。

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

纠错
反馈