Slides as Code Theme

Hugo theme integrating an opinionated distribution of Reveal.js.

Demo

Check out the live demo.

Documentation

See online documentation.

Inspirations

This distribution is inspired by following Hugo themes and projects using Reveal.js

• Hugo Theme Reveal.js
• Reveal Hugo
• GitPitch

Differences with Reveals.js upstream

• Expose preview management functions
• Override Reveal CSS in assets/reveal/reveal.scss (especially disabled perspective to support grid elements)

Fixed elements and transitions

To avoid jumping and flicking fixed position elements (such as blocks, diagrams, charts...), don't use geomtric transitions.

Configuration for Hugo site

baseURL: https://example.org/
languageCode: en-us
disableKinds: ["taxonomy", "taxonomyTerm", "RSS", "sitemap"]
outputs:
  home: ["sac"]
  page: ["sac"]
  section: ["sac"]
themesDir : "/usr/local/share/sac/themes"
theme: ["sac/x.y.z"]
markup:
  goldmark:
    renderer:
      unsafe: true

• Set unsafe to Goldmark render for complete support of markdownify functions (used in some shortcodes)

Project Management

This project adheres to:

• Developer Certificate of Origin
• Conventional Commit Messages
• Semantic Versioning
• Keep a Changelog

Authors

Developed with passion by Stéphane Este-Gracias and great open source contributors.

License

sac-theme

sac-theme's code is released under MIT license.

Third-party Open Source components, Reveal.js plugins and fonts are distributed within this project. See the list and their relative licenses below.

Components

Component	Repository	License
asciinema-player	asciinema/asciinema-player	Apache License 2.0
draw.io	jgraph/drawio	Apache License 2.0
highlight.js	highlightjs/highlight.js	BSD 3-Clause License
reveal.js	hakimel/reveal.js	MIT license
typed.js	mattboldt/typed.js	MIT license

Reveal.js plugins

Plugin	Repository	License
menu	denehyg/reveal.js-menu	MIT license
reveal.js-plugins	rajgoel/reveal.js-plugins	MIT License

Fonts

Font	Repository	License
FontAwesome	FortAwesome/Font-Awesome	Font Awesome Free License
Hack	source-foundry/hack	MIT license
Open Sans	googlefonts/opensans	Apache License 2.0
Raleway	googlefonts/raleway	SIL Open Font License 1.1

Applications on iframe

Application	Repository	License
ttyd	tsl0922/ttyd	MIT License
code-server	cdr/code-server	MIT license

Acknowledgments

• Data Essential to give time and means to develop and maintain this project.