npm 包 gitbook-plugin-steno 使用教程

阅读时长 3 分钟读完

简介

在 Web 应用开发中,使用轻量级的文档生成工具能极大的提升开发效率和团队协作质量,而 GitBook 便是这样一款优秀的工具。与此同时,若能融入更为简便高效的技巧则能带来更好的开发体验。本文将介绍一个 GitBook 插件——gitbook-plugin-steno,它能够实现边编写文档,边生成类似评论的快捷信息,代码格式等效果。

安装和使用

安装

在使用该插件之前,需要首先确保您已经在本地或服务器环境下成功安装了 GitBook。如果您还没有安装,可以参考官方文档:GitBook 安装教程

在安装完成 GitBook 后,您可以运行以下命令,安装 gitbook-plugin-steno 插件:

使用

安装完成后,您需要在 GitBook 的 book.json 中添加相应插件配置,示例代码:

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

其中,enableCodeBlock 开关表示是否启用代码格式化转换组件,此时您所编辑的代码将会在文本框内和最终书籍中以类代码块效果呈现;enableTitle 表示是否启用标题样式加粗效果,此时书籍中标题代表的文本将会以粗体呈现;enableEmoji 则启用了表情代码转换功能,您可以在书籍文本中使用 Emoji 表情。

案例

下面是一个包含代码块、根据标题样式加粗、Emoji 表情的文本示例:

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

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

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

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

Good bye, world. 👋

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

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

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

-- --

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

- ------------------------------------------------------------------------------ --------
------------------------------------------------------------------------------------------------------------------------
纠错
反馈