culas / zuehlke-reveal-package

Zühlke branded reveal.js slidedeck library

Zühlke Reveal.js Package

Package to easily create Zühlke branded reveal.js presentations.

Reveal.js is an open source HTML presentation framework. It enables anyone with a web browser to create beautiful presentations. The framework comes with a powerful feature set including nested slides, markdown support, syntax highlighted code and an extensive API.

This repo contains everything needed to create Zühlke branded reveal.js presentations. A demo is visble at zuehlke-reveal-demo

Usage

Replace <COMMIT_HASH> in the following snippets with the hash from the latest commit on the release branch.

Include the stylesheet in all TOC and chapter files:

<link rel="stylesheet"
      href="https://cdn.jsdelivr.net/gh/webplatformz/zuehlke-reveal-package@<COMMIT_HASH>/release/index.css">

Load and run the script in all chapter files:

<script src="https://cdn.jsdelivr.net/gh/webplatformz/zuehlke-reveal-package@<COMMIT_HASH>/release/index.js"></script>
<script>
	setupZuehlkeRevealPresentation();
</script>

Consult the official documentation of reveal.js for further information on how to use reveal.js.

Special Features

• The comparison class allows side-by-side comparisons in two or more columns (1 column per child element) of both code samples and regular text content.
• Using the class tip (usually on a fragment) displays a purple text box across the slide. This is useful for additional information, hints or tips related to the current slide.
• Highlight parts of your text in a bold Zühlke gradient with the hl class.
• Use the code class for generic inline code snippets (like in this sentence). There is no special syntax highlighting.

Contributing

See the CONTRIBUTING document. Thank you, contributors!

License

Copyright (c) 2022 Zühlke. The repo contains free software, and may be redistributed under the terms specified in the LICENSE file.