Giter Site home page Giter Site logo

bestowed's Introduction

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

.
├── Gruntfile.js      <- Build file
├── README.md         <- this file
├── build/            <- 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 grunt 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 -g grunt
$ npm install -g mocha
$ npm install
$ grunt

The output should be in the build directory.

Running tests

$ mocha

bestowed's People

Contributors

robrohan avatar

Watchers

 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.