https://github.com/haozeke/zenyoda

Pandoc Presentation Engine
https://github.com/haozeke/zenyoda

beamer beamer-template javascript pandoc presentation sass tup

Last synced: about 2 months ago
JSON representation

Pandoc Presentation Engine

• Host: GitHub
• URL: https://github.com/haozeke/zenyoda
• Owner: HaoZeke
• License: gpl-3.0
• Created: 2017-11-10T02:03:55.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-05-24T09:51:12.000Z (about 5 years ago)
• Last Synced: 2025-02-12T16:19:20.512Z (4 months ago)
• Topics: beamer, beamer-template, javascript, pandoc, presentation, sass, tup
• Language: JavaScript
• Homepage: http://zenyoda.surge.sh/#
• Size: 2.36 MB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Zen Yoda  [![Donate](https://img.shields.io/badge/Donate-PayPal-blue.svg?style=for-the-badge)](https://www.paypal.me/HaoZeke/) [![Build Status](https://travis-ci.org/HaoZeke/zenYoda.svg?branch=master)](https://travis-ci.org/HaoZeke/zenYoda)  

[![Greenkeeper badge](https://badges.greenkeeper.io/HaoZeke/zenYoda.svg)](https://greenkeeper.io/)

> Copyright (C) 2017  Rohit Goswami 

![](src/img/turtle.png "Pandoc Presentations for turtles")

A tup driven pandoc presentation engine.

To get started, grab the [starter template](http://zenyodasap.surge.sh/).

For it's gulp driven counterpart for academic documents, refer to the sibling project, [docuYoda](http://docuyoda.surge.sh/) and it's [starter template](http://docuyodasap.surge.sh/).

## Requirements

You'll need:-

* Pandoc v2 or greater

* tup

* A full LaTeX distribution

## Usage

Simply clone the repo and start changing slideConf.yml and slides.md

You can enable file watching by:

```bash

# Runs the monitor and automatically rebuilds on changes

tup monitor -a

# Stop the monitor

tup stop

```

## The site

In case the site interests you, you may use zenYoda for small sites deployable to any static site generator as well.

You'll then need to edit the site.md page. (this documentation was made with site.md )

## Acknowledgments

This software is built on the following:

- [Pandoc](https://github.com/jgm/pandoc)

- [TeX](https://ctan.org/)

- [tup](http://gittup.org/tup/index.html)

- [Metropolis](https://github.com/matze/mtheme)

- [latexmk](http://mg.readthedocs.io/latexmk.html)

- [shx](https://github.com/shelljs/shx)

- [yarn](https://yarnpkg.com/en/)

Additionally, for the site the following tools were used:

- [sassc](https://github.com/sass/sassc)

- [node-sass](https://github.com/sass/node-sass)

- [surge](http://surge.sh)

- [panflute](http://scorreia.com/software/panflute/)

- [imagemin-cli](https://github.com/imagemin/imagemin-cli)

The site is built with:

- [Sass](http://sass-lang.com/)

- [CSS Gird](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Grid_Layout)

- [CSS Variables](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_variables)

- [Travis CI](https://travis-ci.org)

## Contributions

Pull requests welcome!

Please add yourself to the Contributors file as well, with a summary and contact details (optinal).

## Issues

Bug tracking is done with [waffle.io](https://waffle.io/)

[![Waffle.io - Columns and their card count](https://badge.waffle.io/HaoZeke/zenYoda.svg?columns=all)](https://waffle.io/HaoZeke/zenYoda)

## License

The code itself is under the [GNU GPLv3](https://choosealicense.com/licenses/gpl-3.0/) like much of pandoc itself, however, please refer to the exceptions listed [here](https://github.com/jgm/pandoc/blob/master/COPYRIGHT).

Icons made by Freepik from www.flaticon.com is licensed by CC 3.0 BY