https://github.com/rjoberon/bibsonomy-jekyll

BibSonomy plugin for Jekyll
https://github.com/rjoberon/bibsonomy-jekyll

Last synced: about 1 month ago
JSON representation

BibSonomy plugin for Jekyll

• Host: GitHub
• URL: https://github.com/rjoberon/bibsonomy-jekyll
• Owner: rjoberon
• License: gpl-3.0
• Created: 2017-05-31T11:19:17.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-02-10T11:00:10.000Z (almost 5 years ago)
• Last Synced: 2024-10-20T12:20:36.570Z (about 2 months ago)
• Language: Ruby
• Size: 35.2 KB
• Stars: 7
• Watchers: 2
• Forks: 6
• Open Issues: 3
• Metadata Files:
  • Readme: README.markdown
  • License: LICENSE

Awesome Lists containing this project

• awesome-jekyll-plugins - **BibSonomy** - jekyll](https://rubygems.org/gems/bibsonomy-jekyll)) - generate publication lists from [BibSonomy](https://www.bibsonomy.org/). (Bibliography & Citiations)

README

        
# BibSonomy

[BibSonomy](https://www.bibsonomy.org/) plugin for

[Jekyll](http://jekyllrb.com/) which renders bibliographic metadata

using the [Citation Style Language](http://citationstyles.org/).

[![Gem Version](https://badge.fury.io/rb/bibsonomy-jekyll.svg)](http://badge.fury.io/rb/bibsonomy-jekyll)

[![Build Status](https://travis-ci.org/rjoberon/bibsonomy-jekyll.svg?branch=master)](https://travis-ci.org/rjoberon/bibsonomy-jekyll)

[![Coverage

Status](https://coveralls.io/repos/rjoberon/bibsonomy-jekyll/badge.svg)](https://coveralls.io/r/rjoberon/bibsonomy-jekyll)

## Usage

(Read the Jekyll documentation on [installing a plugin](https://jekyllrb.com/docs/plugins/#installing-a-plugin).)

1. Add the following to your site's `Gemfile`:

```

gem 'bibsonomy-jekyll'

```

2. Add the following to your site's `_config.yml`:

```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](https://www.bibsonomy.org/settings?selTab=1#selTab1). **Do

not put your API key into a public repository.**

3. In any page or post, use the plugin as follows:

```markdown

{% 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](https://amor.cms.hu-berlin.de/~jaeschkr/publications.html).

## Development

Install dependencies:

```shell

bundle install

```

Run tests:

```shell

export BIBSONOMY_USER_NAME=yourusername

export BIBSONOMY_API_KEY=yourapikey

bundle exec rspec spec

```

Build gem:

```shell

gem build bibsonomy-jekyll.gemspec

```