Skip to content
This repository has been archived by the owner on Aug 27, 2020. It is now read-only.
/ bestowed Public archive

Extremely simple presentation (ppt, keynote, etc) framework for org-mode export

License

Notifications You must be signed in to change notification settings

robrohan/bestowed

Repository files navigation

Bestowed

Build Status

Bestowed is some simple Javascript and CSS code for creating presentations out of org-mode files. Org-mode is an outlining mode inside of emacs.

Quick Start

If you look in the example directory, you will find an example.org file. Open this file in emacs 24, and type C+c C+e then type h h. The output of this process is example.html in the same folder as the org file. Open example.html in your favourite browser.

Slower than Quick Start, but Still Quick.

In an org-mode file, at the top of the file type: C+c C+e # then type html. Change the following values:

...
#+OPTIONS: html-preamble:t html-scripts:nil html-style:nil
...
#+HTML_DOCTYPE: <!doctype html>
...

And add the following:

#+HTML_HEAD: <meta name="bestowed-theme" value="themes/default"><script async src="http://s3.amazonaws.com/cdn.robrohan.com/bestowed/bestowed.min.js"></script>

Then export the org file as html by doing: C+c C+e then type h h. Open the exported html in your favourite browser (as long as your favourite is the latest Chrome or Safari).

If you prefer, here is a YouTube video about how Bestowed works.

Code Layout

.
├── Makefile          <- Build file
├── README.md         <- this file
├── dist/             <- Build output
├── example/          <- Example Org and present file
├── node_modules/     <- npm makes this
├── package.json      <- package info for grunt
├── src/              <- all the source
└── test/             <- all the awesome tests

Theme Code Layout

Themes do not have to live within the code base, but if they do you can reference them with a relative path.

src
  ├── bestowed.css    <- Main, core styles
  ├── bestowed.js     <- The code itself
  └── themes/         <- Themes directory
      ├── default/    <- Example Theme
      │   ├── css/
      │   └── js/
      └── webqem/     <- Custom Theme
          ├── assets/
          ├── css/
          └── js/

Building the Javascript Code

You will need node and make installed. Node can be installed from the node website or by using your favourite package manager. Once node is installed, npm (node package manager) should also be installed. You should then be able to run the following commands:

$ npm install
$ make

The output should be in the build directory.

Running tests

$ make test

About

Extremely simple presentation (ppt, keynote, etc) framework for org-mode export

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published