npm 包 gitbook-plugin-wrapper 使用教程

前言

对于前端开发者而言,使用 GitBook 是非常便捷的。然而,在使用 GitBook 进行文档编写时,也会遇到一些问题。其中一个问题是,如何轻松实现 Markdown 中插入各种常用的媒体内容,如 YouTube 视频、Slideshare 文档、GitHub 代码等等。而 gitbook-plugin-wrapper 简化了这些需求的实现,本文将详细介绍如何使用该插件。

安装

使用 npm 可以轻松地安装 gitbook-plugin-wrapper 插件:

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

安装完毕之后,需要在 GitBook 的插件列表中进行注册,打开 book.json 文件,添加以下配置:

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

注意,若已经存在其他插件,则需要将 wrapper 插件添加在其中。

使用

使用 gitbook-plugin-wrapper 插件,需要使用以下格式的 HTML 代码:

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

其中 data-type 为需要插入的内容的类型,data-url 为要插入内容的 URL。

常用的类型包括:

  • YouTube:YouTube 的视频。
  • Slideshare:Slideshare 的文档。
  • Codepen:Codepen 的代码块。
  • Twitter:Twitter 的推文。
  • GitHub:GitHub 的代码。

例如,下面是一个插入了 YouTube 视频的例子:

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

这样一来,就可以轻松地将 YouTube 视频插入到 GitBook 的文档中。

关于更多的类型和示例,请参考插件的 GitHub 页面:https://github.com/GitbookIO/plugin-wrapper

总结

使用 gitbook-plugin-wrapper 插件,可以让 GitBook 的文档编写更加方便快捷。在使用时,需要注意 data-typedata-url 的使用格式,并参考插件的示例代码,尤其是针对某些类型(如 GitHub 代码)需要使用特定的参数来进行配置。

此外,在文档编写过程中,需要注意遵守基本文档编写规范,如 Markdown 语法等,以免影响阅读体验。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/600557fb81e8991b448d5156


猜你喜欢

  • npm 包 micro-calendar 使用教程

    前言 在前端开发过程中,日期选择器是非常常见的组件,而 micro-calendar 是一个比较优秀的日期选择器 npm 包。本文将详细介绍 micro-calendar 的使用方法,方便大家快速上手...

    2 年前
  • npm 包 mithril-nested-router 使用教程

    本文介绍了如何使用 mithril-nested-router 这个 npm 包来实现在 Mithril 框架下基于路由的页面导航。 Mithril 简介 Mithril 是一个轻量级且易于上手的...

    2 年前
  • npm 包 @vandalsquad/studio 使用教程

    介绍 @vandalsquad/studio 是一个用于前端开发的 npm 包,它提供了一些实用的工具和组件,可以帮助您更快速、更高效地构建您的项目。 其中,它最大的优点是它能够支持多种前端框架,包括...

    2 年前
  • npm 包 react-onscroll 使用教程

    React-onscroll 是一个高效的 React 组件,用于跟踪用户滚动并在到达某个页面位置时触发指定的操作。使用这个 npm 包可以轻松实现一些不同的滚动效果,例如实现懒加载、无限滚动或类似于...

    2 年前
  • npm 包 normalize-app 使用教程

    在前端开发中,我们经常会碰到不同的浏览器对于样式的不同解析,甚至不同版本的浏览器对于相同的样式属性也会出现不同的解析结果。这不仅影响了开发效率,更严重的是影响了网站的用户体验。

    2 年前
  • npm 包 protocoler 使用教程

    在现代互联网应用程序中,前端和后端通信是非常常见的任务。JavaScript 作为前端主流语言,解决前后端通信的问题也是它的一项重要任务。protocoler 就是一个方便前后端通信的 npm 包,它...

    2 年前
  • npm 包 @theroyalwhee0/northwoods-consoleformatted 使用教程

    简介 @theroyalwhee0/northwoods-consoleformatted 是一个 npm 包,它可以帮助前端开发者在控制台中打印出格式化的日志。 安装 --- ------- ---...

    2 年前
  • npm 包 treactr-canvas-knob 使用教程

    treactr-canvas-knob 是一个基于 Canvas 实现的旋钮组件,可以在 Web 应用程序中用于用户输入和交互。本文将介绍 treactr-canvas-knob 的安装、使用、属性和...

    2 年前
  • npm 包 ng-testbedder 使用教程

    简介 ng-testbedder 是一款帮助 Angular 开发人员更加便捷地编写单元测试的 npm 包。使用这个包可以更加快速地搭建 Angular 组件的测试环境,简化单元测试的编写和运行过程。

    2 年前
  • npm 包 altiore-react 使用教程

    本文将介绍如何使用 altiore-react 这个 npm 包来开发一个前端应用程序。 这里我们将详细说明 altiore-react 这个包的功能、如何安装该包、如何使用该包来构建一个前端应用程序...

    2 年前
  • npm 包 open-ui-toolbox 使用教程

    本文将介绍如何使用 npm 包 open-ui-toolbox 开发前端 UI,该包包含了众多常用的 UI 组件和工具函数,可以大大简化前端开发过程,提高代码的复用性和效率。

    2 年前
  • npm 包 stateslang 使用教程

    简介 stateslang 是一个轻量级的 npm 包,用于管理状态机状态转换。状态机是计算机科学中一个经典的概念,用于描述基于特定输入对程序执行路径的决策。使用 stateslang 可以更容易地实...

    2 年前
  • npm 包 timecafe 使用教程

    简介 在前端开发中,我们经常需要使用时间操作来完成某些功能,比如时间转换、时间间隔计算等。npm 包 timecafe 是一个简单易用的时间操作工具库,能够方便地进行时间计算和格式化,可以大大提高开发...

    2 年前
  • npm 包 gulp-json5-to-json 使用教程

    前言 在前端开发中,我们经常需要使用到 JSON 格式的数据。JSON5 是 JSON 的拓展语法,它可以支持更多的数据类型和注释,可以更方便地编写和维护 JSON 文件。

    2 年前
  • npm 包 micro-radar 使用教程

    随着前端开发的快速发展和不断拓展,前端技术栈也不断涌现出各种新的工具和库。其中,npm 包 micro-radar 作为一个轻量级的实时监测工具,被广泛地运用于前端开发领域中。

    2 年前
  • npm 包 ca-ui-themer 使用教程

    简介 ca-ui-themer 是一个可定制化的 UI 风格配色方案,通过引入该 npm 包并使用其中提供的 API 和组件,可以轻松地为前端应用添加定制化主题配色与样式。

    2 年前
  • npm 包 copy-loopback-auth0-jwt 使用教程

    前言 在开发前端应用时,常常会用到认证授权等功能。而使用 Auth0 作为认证平台,可以解决这些问题。本文将介绍一个基于 Auth0 的 npm 包 copy-loopback-auth0-jwt,该...

    2 年前
  • npm 包 package-alt 使用教程

    在前端开发中,npm 是一个非常重要的工具,它可以帮助我们管理依赖、打包、发布等。在这些 npm 包中,有一个非常有用的包,叫做 package-alt,它可以帮助我们更轻松方便地进行模块化开发和代码...

    2 年前
  • npm 包 npud 使用教程

    前言 在前端开发中,我们经常需要管理我们的项目中使用到的依赖包,最常见的方式就是使用 npm。npm 是 Node.js 的包管理工具,既可以用于从 npm 仓库(npm registry)下载安装我...

    2 年前
  • npm 包 pull-flatten-deep 使用教程

    前言 在进行前端开发时,我们通常会使用到很多第三方包来提高开发效率和代码可维护性。其中,npm 是一个非常流行的包管理器,可以帮助我们方便地安装、管理以及发布代码包。

    2 年前

相关推荐

    暂无文章