# Jekyll Avatar
*A Jekyll plugin for rendering GitHub avatars*
[](https://travis-ci.org/benbalter/jekyll-avatar)
Jekyll Avatar makes it easy to add GitHub avatars to your Jekyll site by specifying a username. If performance is a concern, Jekyll Avatar is deeply integrated with the GitHub avatar API, ensuring avatars are cached and load in parallel. It even automatically upgrades users to Retina images, when supported.
## Installation
Add the following to your site's `Gemfile`:
```ruby
gem 'jekyll-avatar'
```
And add the following to your site's `_config.yml` file:
```yaml
gems:
- jekyll-avatar
```
## Usage
Simply add the following, anywhere you'd like a user's avatar to appear:
```
{% avatar [USERNAME] %}
```
With `[USERNAME]` being the user's GitHub username:
```
{% avatar hubot %}
```
That will output:
```html
```
### Customizing
You can customize the size of the resulting avatar by passing the size argument:
```
{% avatar hubot size=50 %}
```
That will output:
```html
```
### Passing the username as variable
You can also pass the username as a variable, like this:
```
{% assign username="hubot" %}
{% avatar {{ username }} %}
```
Or, if the variable is someplace a bit more complex, like a loop:
```
{% assign employees = "alice|bob" | split:"|" %}
{% for employee in employees %}
{% avatar user=employee %}
{% endfor %}
```
### Using with GitHub Enterprise
To use Jekyll Avatars with GitHub Enterprise, you must set the `PAGES_AVATARS_URL` environmental variable.
This should be the full URL to the avatars subdomain or subpath. For example:
* With subdomain isolation: `PAGES_AVATARS_URL="https://avatars.github.example.com"`
* Without subdomain isolation: `PAGES_AVATARS_URL="https://github.example.com/avatars"`