The official website for jCanvas, the jQuery canvas library
Switch branches/tags
Nothing to show
Clone or download

README.md

jCanvas Website

Copyright 2016-2017, Caleb Evans
Released under the MIT license

This repository hosts the official website for jCanvas, the jQuery canvas library.

Running the website locally

You are welcome and encouraged to clone this repository so you can have a local copy of the entire jCanvas documentation.

1. Clone repository

git clone https://github.com/caleb531/jcanvas-website.git

2. Install Jekyll and Bundler

The site requires Jekyll (3.0 or newer) and Bundler (1.12 or newer).

gem install jekyll
gem install bundler

3. Install site gems

bundle install

4. Download submodules

The site includes the jCanvas source repository as a submodule, so be sure to initialize that too.

git submodule update --init --recursive

5. Serve site locally

bundle exec jekyll serve

Contributing

See any mistakes in the documentation or errors in the code? Please submit an issue or pull request! All code contributions are welcome.