hexo-reveal-embed

1.7.0 • Public • Published

Hexo Reveal Embed

This Hexo plugin allows you to display slides created with reveal.js on your blog. Both embedded display and full screen display are possible.

Requirements

  • Hexo 6 or later
  • Node.js 18.0 or later

Installation

npm install hexo-reveal-embed

You can find an overview of how to install and configure it in the following blog post (Japanese):
次のブログ記事で、インストールと設定の概要を確認できます:

ブログ記事へのスライド埋め込みプラグイン Hexo Reveal Embed を公開した

How To Use

  1. Create your slides with reveal.js.

    Create a reveal.js slide in markdown format under the source/_slides/ directory. You can see how to create slides using markdown with reveal.js here.

    You can write front-matter at the beginning of markdown. Use this to set the slide page title and slide theme.

  2. Generate slide pages.

    As usual, when you run hexo generate or hexo server, a slide page will be created under the /<public_dir>/slide/ directory.

  3. View slides full screen.

    When you access the URL under /slide/ in your browser, the slide you created will be displayed in full screen.

  4. Embed the slide in a blog post.

    Embed slides in your post with the following tag:

    {% reveal "path/to/file" %}

    Specify the path to the slide in path/to/file. In the above example, the slide created in source/_slides/path/to/file.md and published to /slide/path/to/file.html will be embedded. It will be rendered as follows.

    <div class="hexo-reveal-embed">
      <iframe
        src="/slide/path/to/file.html"
        allowfullscreen
        loading="lazy"
      >
      </iframe>
    </div>
  5. Adjust the design

    This plugin does not make any design adjustments so that you can set the design as you like.

    Use the .hexo-reveal-embed class set in the embedded tag and freely set the css. For example, the following css would display the entire width of the parent element and set the aspect ratio to 16:9.

    .hexo-reveal-embed {
      width: 100%;
      height: 0;
      padding-top: 56.25%; /* 16:9 ratio (9/16 = 0.5625) */
      position: relative;
    }
    
    .hexo-reveal-embed iframe {
      width: 100%;
      height: 100%;
      position: absolute;
      top: 0;
    }

Front-matter

Front-matter allows you to configure the following settings for each slide.

  • title The title of the slide page. This will be displayed in the browser tab.
  • theme You can specify the name of the theme provided by reveal.js. You can check the list here.

Configuration

You can configure the behavior of reveal.js from your blog's _config.yml.

default

Set the default value of front-matter for each slide. For example, to set the theme of all slides to white by default, use the following:

reveal:
  default:
    theme: white

If both are set, front-matter takes precedence.

anchor_target

Set the target attribute of the a tag. Default is _top.

reveal:
  anchor_target: _blank

config

The reveal.config settings will be passed to reveal.js as is. The list of reveal.js settings can be found here.

For example, to enable URL Fragment and Browser History for a slide in full screen view:

reveal:
  config:
    hash: true
    history: true

plugins

You can configure which plugins should be loaded, for example:

reveal:
  plugins:
    # Specify only the name of the plugin bundled with reveal.js:
    - RevealHighlight
    - RevealNotes
    # Specify the `name` and `url` of the third-party plugin
    - name: ThirdPartyPlugin
      url: https://thirt-party.example.com/path/to/plugin.js

NOTE: RevealMarkdown is automatically loaded even if you do not specify it.

Specify the plugin that is bundled with reveal.js. The list of available plugins can be found here.

css_urls / js_urls

You can specify additional css and js to load, for example:

reveal:
  css_urls:
    - https://thirt-party.example.com/path/to/style.css
    - /path/to/local/style.css
  js_urls:
    - https://thirt-party.example.com/path/to/script.css
    - /path/to/local/script.css

Contributing and Development

# Clone this repository and move to the directory:
git clone https://github.com/KentarouTakeda/hexo-reveal-embed.git
cd hexo-reveal-embed

# Install dependencies:
npm install

# Run tests:
npm test

License

Hexo Reveal Embed is open-sourced software licensed under the MIT license.

Package Sidebar

Install

npm i hexo-reveal-embed

Weekly Downloads

17

Version

1.7.0

License

MIT

Unpacked Size

14.5 kB

Total Files

7

Last publish

Collaborators

  • kentaroutakeda