https://github.com/quacksouls/honkit-plugin-youtube

Link to a YouTube video in HonKit
https://github.com/quacksouls/honkit-plugin-youtube

gitbook gitbook-plugin honkit honkit-plugin javascript

Last synced: 1 day ago
JSON representation

Link to a YouTube video in HonKit

• Host: GitHub
• URL: https://github.com/quacksouls/honkit-plugin-youtube
• Owner: quacksouls
• License: apache-2.0
• Created: 2023-10-05T07:31:01.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-26T08:13:37.000Z (about 1 year ago)
• Last Synced: 2023-12-27T09:07:22.364Z (11 months ago)
• Topics: gitbook, gitbook-plugin, honkit, honkit-plugin, javascript
• Language: JavaScript
• Homepage:
• Size: 9.77 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# HonKit plugin: youtube

Link to a YouTube video in HonKit.

## Installation

Install via npm:

```sh

npm install honkit-plugin-youtube --save-dev

```

Add the plugin to your `book.json`:

```js

{

    plugins: [ "youtube" ]

}

```

## Usage

Link to a YouTube video as follows:

```

{% youtube id="video_id", title="video_title" %}{% endyoutube %}

```

* `id` -- The ID of the YouTube video.  For example, if the URL of the video is


  https://www.youtube.com/watch?v=p3G5IXn0K7A


  then the ID of the video is `p3G5IXn0K7A`.

* `title` -- The title of the video.

Here is an example:

```

{% youtube id="p3G5IXn0K7A", title="The Hamsterdance Song" %}{% endyoutube %}

```

The video title might have double quotation marks. You should backslash escape each

double quotation mark as follows:

```

{% youtube id="p3G5IXn0K7A", title="The \"Hamsterdance\" Song" %}{% endyoutube %}

```