BibSonomy plugin for Jekyll
Ruby
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
spec
.gitignore
.travis.yml
Gemfile
LICENSE
README.markdown
Rakefile
bibsonomy-jekyll.gemspec

README.markdown

BibSonomy

BibSonomy plugin for Jekyll which renders bibliographic metadata using the Citation Style Language.

Gem Version Build Status

Usage

(Read the Jekyll documentation on installing a plugin.)

  1. Add the following to your site's Gemfile:
gem 'bibsonomy-jekyll'
  1. Add the following to your site's _config.yml:
gems:
  - bibsonomy-jekyll

bibsonomy:
  user: yourusername
  apikey: yourapikey
  # directory must exists; empty value disables document download
  document_directory: pdf
  # check https://github.com/citation-style-language/styles for styles
  style: acm-sig-proceedings
  # see http://api.altmetric.com/embeds.html for types and JavaScript
  # to enable them; empty value disables rendering
  altmetric_badge_type: 1

You can get your BibSonomy API key from the settings page. Do not put your API key into a public repository.

  1. In any page or post, use the plugin as follows:
{% bibsonomy user yourusername myown 3 %}

You should adapt the user name (yourusername) and tag(s) (myown) to your needs.

The plugin supports a variable number of parameters: GROUPING NAME TAG1 ... TAGN COUNT

  • GROUPING specifies whether posts for a user ("user") or group ("group") shall be rendered.
  • NAME specifies the name of the user or group.
  • TAG1 ... TAGN is a variable number of tags the posts should have.
  • COUNT is the maximal number of posts that shall be rendered.

Examples

For an example output, have a look at my publication list.