npm 包 gitbook-plugin-steno 使用教程

简介

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

安装和使用

安装

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

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

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

使用

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

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

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

案例

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

- -------

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

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

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

Good bye, world. 👋

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

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

-- --

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

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

猜你喜欢

  • npm 包 koa2-webpack-middleware-plus 使用教程

    在前端开发中,WebPack已经成为了一种非常流行的工具。同时,Koa2也因为其简洁高效的特点而得到了广泛的应用。 如何将这两个工具完美结合,让前端开发变得更加轻松?答案是使用 npm 包 koa2-...

    3 年前
  • npm 包 vie-joy 使用教程

    1. 前言 vie-joy 是一个基于 Vue.js 的 UI 框架,它提供了一系列的组件供开发者使用,如按钮、表格、消息提示等等。同时,vie-joy 还具有灵活的配置和扩展能力,可以方便地根据项目...

    3 年前
  • npm 包 webpack-koa2-server 使用教程

    前言 在前端开发中,构建工具扮演着不可或缺的角色,它们能够帮助我们管理项目中的依赖、优化代码、打包资源等。其中 webpack 是其中比较常用的一个工具,而 webpack-koa2-server 则...

    3 年前
  • npm 包 ax6ui-es 使用教程

    在前端开发过程中,我们经常需要使用一些 UI 库或组件库来快速搭建网站或应用的界面,其中 ax6ui-es 是一个优秀的 npm 包,它提供了一系列的 UI 组件,可以大大提高我们的开发效率。

    3 年前
  • npm 包 atom-checkbox 使用教程

    Atom-checkbox 作为一种常见的前端组件被广泛使用,是前端开发中不可缺少的工具之一。本文将介绍如何使用 npm 包 atom-checkbox,并提供详细的使用教程。

    3 年前
  • npm 包 ax6ui 使用教程

    前言 随着互联网的发展,前端开发变得越来越重要,各种框架和库层出不穷。其中一个非常受欢迎的框架是 React,而一个非常实用的库就是 ax6ui(以下简称 ax6)。

    3 年前
  • npm 包 mock-variable 使用教程

    介绍 前端开发中,mock 数据是必不可少的环节之一。而使用 mock 数据的过程中,我们经常需要随机获取一个符合条件的变量。这时,我们可以使用一个 npm 包 mock-variable 来简化我们...

    3 年前
  • npm 包 mup-fix-bin-paths 使用教程

    在前端开发中,我们经常需要使用到一些工具包和依赖库,其中不乏一些需要通过命令行来执行的工具。而在使用这些工具时,我们经常会遇到一些问题,其中之一便涉及到二进制文件路径的问题。

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

    在前端开发中,Webpack 已成为一种非常流行的打包工具。generator-webpack-boilerplate 就是一个基于 Webpack 的脚手架工具,可以帮助开发者快速搭建一个 Webp...

    3 年前
  • npm 包 alfred-translate 使用教程

    简介 alfred-translate 是一款基于 Node.js 和 Alfred Workflow 实现的翻译工具,它使用了腾讯 AI Lab 的翻译 API,支持中英文互译、其它语言到中文的翻译...

    3 年前
  • npm 包 generator-simple-reactapp-gulp 使用教程

    简介 generator-simple-reactapp-gulp 是一个用于快速生成 React 应用的 Yeoman 生成器。它基于 generator-simple-gulp-browserif...

    3 年前
  • npm 包 hnm1 使用教程

    简介 在前端开发中,我们经常需要处理时间,然而 JavaScript 的 Date 对象并不是很方便使用。因此,我们需要一个方便易用的时间处理工具。hnm1 是一个基于 moment.js 封装的时间...

    3 年前
  • npm 包 nock-slider 使用教程

    前言 在前端开发中,我们经常需要与后端进行数据交互,因此需要模拟后端 API 接口。这时候 nock-slider 就成为一个不可缺少的工具了。nock-slider 可以帮助我们模拟后端接口,使我们...

    3 年前
  • npm 包 artist-canvas 使用教程

    什么是 artist-canvas? Artist Canvas 是一个 npm 包,用于绘制图形和动画。它使用 HTML5 canvas 和 JavaScript 来创建高度可定制的图形。

    3 年前
  • npm 包 artist-helpers 使用教程

    什么是 npm 包? npm 是 node.js 的包管理工具,它允许开发者将自己的项目作为包进行发布和分享,并能够方便地管理项目依赖关系。npm 上有着大量的开源项目,是前端开发最常用的工具之一。

    3 年前
  • npm 包 edit-file 使用教程

    简介 edit-file 是一个基于 Node.js 的 npm 包,为开发者提供了方便快捷地编辑本地文件的方法。在前端开发中,经常需要编辑或查看配置文件或者测试数据等本地文件,这时 edit-fil...

    3 年前
  • npm 包 @mcw/drawer 使用教程

    前言 本篇教程将介绍如何使用 npm 包 @mcw/drawer 实现一个带有抽屉的 web 应用程序。本教程的目标读者是拥有一定前端开发基础的开发者,需要了解 npm、Vue.js 等相关技术。

    3 年前
  • npm 包 @mcw/theme 使用教程

    @mcw/theme 是一个基于 Material Components for the Web 的主题样式库。它提供了一系列的样式类,可以方便地改变 Material Components for ...

    3 年前
  • @mcw/toolbar NPM包使用教程

    介绍 @mcw/toolbar 是一个基于 Material Design 的轻量化工具条组件,支持响应式设计和多种样式类型的自定义,可以帮助开发者快速搭建页面工具条,提升用户体验。

    3 年前
  • npm 包 @mcw/typography 使用教程

    介绍 在设计网站时,选择合适的字体和排版对于页面的视觉效果和易读性都有很大的影响。而使用现成的排版库可以让我们轻松地实现这个目标。@mcw/typography 就是其中之一,它提供了优雅的排版风格和...

    3 年前

相关推荐

    暂无文章