ezprez's Introduction

ezprez template

A repo to bootstrap ezprez usage

This demo assumes you are:

Using GitHub
Using GitHub pages for deployment (see FAQ for setting up other deployment options)

Setup

Click on "Use this template" on the GitHub Repo
On the new repository page MAKE SURE YOU CHECK OFF "Include all branches"
Follow the steps in usage to begin creating your presentation locally

Usage

Here are the steps for doing local development:

Install dependencies by running pip install ezprez or sudo pip3 install ezprez
Read the usage documentation for ezprez
Fill out example.py; add in your Slide's and fill out TODO's
Push your changes and the pipeline will auto-deploy to github pages

FAQ

📊 How do I preview my presentation locally? 📊

To preview your presentation locally you need to:

Run python example.py or python3 example.py
Open /Presentation/index.html in a browser

📷 How do I add in images? 📷

There are a few steps to use images in your presentation

Add your images to /images
Use an Image Component that just has the filename i.e. if the image is called kieran-wood-lp-ice-caps-4k-w-peng.jpg in /images then you want to use "kieran-wood-lp-ice-caps-4k-w-peng.jpg" in the Image Component

💻 How do I use other hosting services? 💻

When you run example.py the static html is exported to /Presentation so you can just deploy those files to any static file host (index.html is the whole presentation)

Recommend Projects