JavaScript CoffeeScript CSS Ruby
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
_data
_guides
_includes
_layouts
_posts
_templates
bin
css
docs
images
js
lib
.gitignore
CNAME
README.md
_config.yml
app_files.json
download.html
examples.html
favicon.ico
index.html
package.json
starter.zip
static.rake

README.md

batmanjs.github.io

Development

http://batmanjs.org is run on GitHub pages and uses Jekyll.

To test your changes locally:

gem install jekyll
jekyll serve

Then check out http://localhost:4000.

Generating the Guides

Raw text for guides is in _guides/. To regenerate the pages after editing them, run

bin/generate_guides

Generating the API documentation

The API docs are generated from a set of literate CoffeeScript files in the main batman.js repository. To generate them yourself, make sure you've cloned the main repo, and execute the following command from within your copy of the batmanjs.github.io repo.

cd ~/code/batmanjs.github.io                # or wherever you keep it
npm install
bin/generate_docs --dir ~/code/batman/docs  # or wherever you keep batman.js source