https://github.com/jackey8616/hexo-generator-slidehtml

A hexo plugin to generate slide html when build / generating hexo project.
https://github.com/jackey8616/hexo-generator-slidehtml

hexo hexo-plugin react slides

Last synced: 2 months ago
JSON representation

A hexo plugin to generate slide html when build / generating hexo project.

• Host: GitHub
• URL: https://github.com/jackey8616/hexo-generator-slidehtml
• Owner: jackey8616
• Created: 2018-05-30T02:18:44.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-08-01T17:22:46.000Z (over 1 year ago)
• Last Synced: 2024-10-11T00:44:52.454Z (3 months ago)
• Topics: hexo, hexo-plugin, react, slides
• Language: EJS
• Homepage: https://jackey8616.github.io/hexo-generator-slidehtml
• Size: 582 KB
• Stars: 6
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# hexo-generator-slidehtml  

[![npm version](https://badge.fury.io/js/hexo-generator-slidehtml.svg)](https://badge.fury.io/js/hexo-generator-slidehtml)

A hexo plugin to generate slide html when build / generating hexo project.

# Usage

Normally hexo would generate index.html in folder.

This will generate a slide.html in same folder for you.

Simply visit `https://[yousite]/path/to/your/article/slide.html` to quickly have a presentation.

If you have a article with a simple post settup.  

```md

---

title: Hello World

slidehtml: true

---

```

this will generate a slide page for it.  

# Demo  

```

Because hexo would update posts link everytime after edit it.

So plz everyone intertesting in demo, just reference this project's site, every post in it have different setup.

You can find the post's source in branch gh-pages-build. 

And each post add a tail url or /slide.html can check its slide.

```

[Website](https://jackey8616.github.io/hexo-generator-slidehtml/)  

# Config

```yml

slidehtml: 

  // Merge title as first slide page.

  titleMerge: true

  // For reveal.js's page separator, remember escape special character like '\' .

  horizontalSeparator: '^\\n---\\n'

  verticalSeparator: '^\\n--\\n'

  // none/fade/slide/convex/concave/zoom default is none.

  slideTransition: none

```

# Installation  

`npm i hexo-generator-slidehtml`

# Post Attribute

These attribute in post can override plugin's global setup.

```

---

slidehtml:

  titleMerge: true

  horizontalSeparator: ''

  verticalSeparator: ''

  slideTransition: none

---

```

Be advice that: plugin Config using YAML as format. so it's need escape char(\) for special char.  

But post setup is Markdown format, so escape char(\) only focus on markdown itself.  

# License

MIT