Skip to content
This repository has been archived by the owner on Jan 24, 2019. It is now read-only.

Commit

Permalink
initial push for new docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dseif committed Nov 26, 2011
0 parents commit 55ff4e0
Show file tree
Hide file tree
Showing 103 changed files with 3,044 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .gitignore
@@ -0,0 +1,5 @@
# OS X ignores
.DS_Store

# Jekyll ignores
_site
9 changes: 9 additions & 0 deletions _config.yml
@@ -0,0 +1,9 @@
# Github defaults
safe: true
lsi: false
pygments: true

# Popcorn.js settings
auto: true
server: true

Empty file added effects/2012-12-12-index.md
Empty file.
34 changes: 34 additions & 0 deletions effects/_posts/2012-12-12-applyclass.md
@@ -0,0 +1,34 @@
# ApplyClass #

## Purpose ##

Apply css class to jquery selector. Selector is relative to plugin target's id

## Options ##

* **class** - specifies the class to apply to the plugin container, can be seperated by spaces for more then one class

## Examples ##

var popcorn = Popcorn( "#video" );

popcorn.footnote({
start: 2,
end: 6,
text: "TOGGLING EVENTS",
target: "footnote",
effect: "applyclass",
applyclass: "test1, test2"
})
.footnote({
start: 20, // seconds
end: 45, // seconds
target: "footnotediv",
text: "Visit webmademovies.org for more details",
effect: "applyclass",
applyclass: "applyoverlay: .overlay, hover: parent"
});

popcorn.play();

Simple applyclass effect [jsFiddle](http://jsfiddle.net/68tzd/)
Empty file.
19 changes: 19 additions & 0 deletions getting-started/_posts/2012-12-12-gettingstarted.md
@@ -0,0 +1,19 @@
# Getting Started #

We urge the video community, Javascript developers, and film makers alike to get involved and help with development in order to ensure an easy to use and adaptable library. There are many ways one can get involved; some include critiquing current work, filling out tickets/bugs, requesting additional functionality, spreading the word, and helping with documentation. Included below are ways to keep track of popcorn.js.

## Download Source ##

We have started a [GitHub repository](https://github.com/webmademovies/popcorn-js) feel free to fork from it or download the source. If you want to contribute the this is the [developer repository](http://github.com/cadecairos/popcorn-js/)

## Workflow Guide ##

The developer workflow guide can be found on [Lighthouse](https://webmademovies.lighthouseapp.com/projects/63272/workflow)

## Issue Tracker ##

We have started a [Lighthouse project](https://webmademovies.lighthouseapp.com/projects/63272/overview). It is public so feel free to add tickets.

## IRC ##

To get involved in the conversation or just stop by to see whats happening visit the #popcorn channel at irc://moznet/popcorn

0 comments on commit 55ff4e0

Please sign in to comment.