Giter Club home page Giter Club logo

reveal-cljs's Introduction

reveal-cljs

Clojure CI https://github.com/n2o/reveal-cljs/releases https://github.com/n2o/reveal-cljs/blob/master/LICENSE

Inspired by the great work on reveal.js and the dislike towards JavaScript, this small project was created to provide a simple wrapper in ClojureScript to create awesome presentations. All features from reveal.js can be used. Check the official documentation of reveal.js for more information about it.

๐ŸŒ… Find a demo of reveal-cljs on this page: https://n2o.github.io/reveal-cljs/

It uses Hiccup-syntax for templating, which makes it very easy to create slides.

Start the project with make repl and see your live slides. Start speaker-mode by pressing s in the slides in your browser.

sample.png

Requirements

Tested with AdoptOpenJDK 16, see CI Build Job for more details in the environment.

A JDK, Clojure's CLI Tools, yarn and make are necessary to build and run the project.

Usage

Set your desired options in core.cljs. More options can be found here.

Create your slides in slides.cljs and add them to the list in the function all.

Then start the development server as seen in the Setup section.

Installation & Setup

Everything in one command:

make

To get an interactive development environment, run:

make repl

Figwheel opens your browser at localhost:9500. This will auto compile and send all changes to the browser without the need to reload.

Open Speaker Notes by pressing s.

Compile and Prepare for Deployment

You can compile the cljs-Code and put the assets together to make your presentation ready to be deployed on a webserver (e.g. on GitHub Pages). By following these steps, you can publish the presentation on a regular server, which only needs to serve HTML, CSS and JavaScript Files. This is all put into one task:

make web

Follow the steps on the terminal to find your prepared presentation.

Software

This project uses external packages, which can be removed by you, since most of them are not essential:

License

Copyright ยฉ 2016 โ€“ 2023 Christian Meter and Contributors

Distributed under the MIT License.

reveal-cljs's People

Contributors

brain-fuel avatar kazesberger avatar miwer106 avatar n2o avatar oliyh avatar tjmaynes avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.