This repository has been archived by the owner. It is now read-only.
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_includes
_institutions
_layouts
_sass
assets
contributors
css
tutorials
welcome
.gitignore
.travis.yml
404.html
CNAME
Gemfile
ISSUE_TEMPLATE.md
LICENSE
README.md
_config.yml
contributors.md
favicon.ico
favicon.png
index.md
reference.md
test.rb
tutorials.md

README.md

Phovea Website

Build Status

The new Phovea website built with Jekyll, SASS, Bourbon, Neat, and Bitters.

Emulating github-pages

The site is built by Github using Jekyll. To preview locally, use the github-pages gem. Briefly:

# Ruby version must be >= 2.0.0.
ruby --version
# Install bundler for dependency management:
gem install bundler
# Fetch dependencies:
bundle install
# Start server:
bundle exec jekyll serve
# Get the most recent version of 'github-pages' gem:
bundle update

More information

Jekyll Plugins

The only supported plugins are those that come with the github-pages gem.

Liquid Syntax

https://github.com/Shopify/liquid/wiki/Liquid-for-Designers

Writing interactive documentation

When contributing documentation, put each individual page in the _documentation collection as a markdown file.

If your documentation contains code, you should write the code in a separate file, which you put into a sub-folder of the _documentation folder. By convention, this folder should have the same name as your markdown file.

To include code on the page, you can use the following jekyll code:

```javascript
{% include_relative path/to/your/code.js %}
```

Testing the tutorial examples

The tutorial examples are tested by Travis. If there are failures...:

  1. Make sure the output in the iframes looks right.
  2. If that doesn't help, run the qunit.html locally.
  3. If that doesn't help, run selenium to run qunit locally.

(Conversely, if the iframe doesn't look right, but tests are passing, strengthen the tests.)