README.md

LayerVault Jekyll Plugins

Plugins that add extra LayerVault-specfic functionality to our public pages.

Available Plugins

All plugins return a URL. You must build the HTML element yourself.

Assets

# Asset Group/Asset.png in latest revision of File.psd
{% lv_asset "File.psd" "Group/Asset.png" %}
{% lv_asset "File.psd" "-" "Group/Asset.png" %}
# => https://layervault.com/organization/project/File.psd/assets/Group/Asset.png?raw=1

# Asset Group/Asset.png in revision 12 of File.psd
{% lv_asset "File.psd" "12" "Group/Asset.png" %}
# => https://layervault.com/organization/project/File.psd/revisions/12/assets/Group/Asset.png?raw=1

Previews

# First preview in latest revision of File.psd
{% lv_preview "File.psd" %}
# => https://layervault.com/organization/project/File.psd/previews/1?raw=1

# 2nd preview of latest revision of File.psd
{% lv_preview "File.psd" "-" "2" %}
# => https://layervault.com/organization/project/File.psd/previews/2?raw=1

# First preview of 2nd revision of File.psd
{% lv_preview "File.psd" "2" %}
# => https://layervault.com/organization/project/File.psd/revisions/2/previews/1?raw=1

# 2nd preview of 3rd revision of File.psd
{% lv_preview "File.psd" "3" "2" %}
# => https://layervault.com/organization/project/File.psd/revisions/3/previews/2?raw=1

Project

{% lv_project %}
# => https://layervault.com/organization/project

Download

# Latest revision of File.psd
{% lv_download "File.psd" %}
# => https://layervault.com/organization/project/File.psd?raw=1

# 2nd revision of File.psd
{% lv_download "File.psd" "2" %}
# => https://layervault.com/organization/project/File.psd/revisions/2?raw=1

Self-Hosting

First, add the gem to your Gemfile and bundle install.

gem 'lv-jekyll-plugins'

Next, the Jekyll _config.yml must contain entries for your organization and a project. You should also add the plugin to the list of gems.

organization: your-organization
project: your-project
gems:
  - lv-jekyll-plugins

And that should do it! When you build your project, all LayerVault tags should be correctly generated. If you run into any issues, please open a GitHub issue with as many details as you can provide.