https://github.com/sagikazarmark/hugo-reveal
Beautiful presentations built with Hugo and Reveal.js
https://github.com/sagikazarmark/hugo-reveal
hugo hugo-theme-component revealjs
Last synced: 7 months ago
JSON representation
Beautiful presentations built with Hugo and Reveal.js
- Host: GitHub
- URL: https://github.com/sagikazarmark/hugo-reveal
- Owner: sagikazarmark
- License: mit
- Created: 2022-04-22T22:20:27.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-10-31T03:29:20.000Z (almost 3 years ago)
- Last Synced: 2025-03-06T18:52:46.448Z (7 months ago)
- Topics: hugo, hugo-theme-component, revealjs
- Language: CSS
- Homepage: https://hugo-reveal.sagikazarmark.dev/
- Size: 1.88 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📽️ hugo-reveal
[](https://app.netlify.com/sites/hugo-reveal/deploys)
**Beautiful presentations built with [Hugo](https://gohugo.io) and [Reveal.js](https://revealjs.com).**
This Hugo theme/module helps creating beautiful Reveal.js presentations embedded in your existing Hugo-based website.
⚠️ **This project is still under heavy development! Things may change or break.** ⚠️
## Wait...what? hugo-reveal? reveal-hugo?
There is another (awesome) project out there called [reveal-hugo](https://reveal-hugo.dzello.com) made by [@dzello](https://dzello.com/).
It also helps you turning any Hugo-based website into Reveal.js presentations and its front page looks exactly the same (I totally stole that).
I tried that project, before creating this one, but I quickly realized I was looking for something else:
I like embedding presentations into my personal website and reveal-hugo is simply not built that way.
So after a couple hours of playing with reveal-hugo, I created this project: hugo-reveal.
Clever name, right?
**TL;DR**
If you want to create a website only containing presentations, give [reveal-hugo](https://reveal-hugo.dzello.com) a try.
Otherwise, this project might be of better use.
## Quickstart
TODO
## Usage
## Attributions
[Reveal.js](https://revealjs.com) assets [bundled](static/reveal/) with this theme are licensed under the [MIT License](https://github.com/hakimel/reveal.js/blob/master/LICENSE).
This project is **_heavily_** inspired by [reveal-hugo](https://reveal-hugo.dzello.com) made by [@dzello](https://dzello.com/).
Make sure to check it out, maybe it works better for you than this project.
Some of the bundled themes (namely `robot-lung` and `sunblind`) are also made by [@dzello](https://dzello.com/), licensed under...the [MIT License](https://github.com/dzello/revealjs-themes/blob/master/LICENSE). Shocking!
## License
The project is licensed under the [MIT License](LICENSE).