simpre
v0.8.8
Published
HTML presentation framework
Downloads
22
Readme
SimPre - a 10KB HTML presentation framework
I've always wanted a minimalistic presentation framework that formats my slides correctly. SimPre scales and positions my content, using all the available space. In addition, it comes with a syntax highlighter and progress indicator.Move on and see how to use it.
- Demo simpre.vercel.app
- Download simpre.zip
Usage
It's just a single HTML file:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>SimPre - The Simplest Presentation HTML Framework</title>
<link rel="stylesheet" href="https://simpre.vercel.app/assets/prism.css" />
<link rel="stylesheet" href="https://simpre.vercel.app/assets/styles.css" />
<script src="https://simpre.vercel.app/assets/simpre.js"></script>
<script src="https://simpre.vercel.app/assets/prism.js"></script>
</head>
<body>
<section>
<h1>Hey 👋</h1>
</section>
<div id="progress"></div>
</body>
</html>Every <section> tag is a slide:
<section>
<p>Slide with text</p>
</section>All the code lives outside the framework. Create a file, add the code inside and load the file via the following <script> tag:
<section>
<script
src="https://simpre.vercel.app/assets/is.js"
data-file="<path to a file>">
</script>
<section>There is "smart" selection mode. When showing code, I often want to emphasize or hide part of it. To help myself in this direction, I did a little feature that you can turn on and off via the Shift key. Select part of the text on this page and press the Shift key to see how it works.
If you need to emphasize on a part of the code you can use the data-sections attribute on the <script> tag. This will create a seprate slide for each of the sections. For example:
<script
src="https://simpre.vercel.app/assets/is.js"
data-file="slides/template.html"
data-sections="2-8,10">
</script>This will highlight the code between line 2 and 8 including. After that the code at line 10. You can also set a value of !2-8,10 (notice the ! in the beginning). This will trigger the first highlighting automatically.
In some cases you may need to implement a custom logic for your slide. If that's the case use the following data attributes attached to your <section> tag:
<script>
window.onEnter = async function (element) {
// ... do some potential async logic
}
window.onChange = async function (element, direction) {
// Return "true" if you want to move forward
// with the slide change.
return true;
}
</script>
<section data-onenter="onEnter" data-onchange="onChange"></section>The onChangeCustomLogic function will be fired when you try to go away from the slide. It will be called again and again until you execute the passed done callback. The onEnterCustomLogic is called when you enter the slide.
You can also use Simpre.nextSlide() and Simplre.previousSlide() global functions to control the slides.