1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
|
# Jekyll Avatar
*A Jekyll plugin for rendering GitHub avatars*
[](https://github.com/jekyll/jekyll-avatar/actions/workflows/ci.yml)
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
plugins:
- jekyll-avatar
```
Note: If you are using a Jekyll version less than 3.5.0, use the `gems` key instead of `plugins`.
## 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
<img class="avatar avatar-small" src="https://avatars3.githubusercontent.com/hubot?v=3&s=40" alt="hubot" srcset="https://avatars3.githubusercontent.com/hubot?v=3&s=40 1x, https://avatars3.githubusercontent.com/hubot?v=3&s=80 2x, https://avatars3.githubusercontent.com/hubot?v=3&s=120 3x, https://avatars3.githubusercontent.com/hubot?v=3&s=160 4x" width="40" height="40" />
```
### Customizing
You can customize the size of the resulting avatar by passing the size argument:
```
{% avatar hubot size=50 %}
```
That will output:
```html
<img class="avatar" src="https://avatars3.githubusercontent.com/hubot?v=3&s=50" alt="hubot" srcset="https://avatars3.githubusercontent.com/hubot?v=3&s=50 1x, https://avatars3.githubusercontent.com/hubot?v=3&s=100 2x, https://avatars3.githubusercontent.com/hubot?v=3&s=150 3x, https://avatars3.githubusercontent.com/hubot?v=3&s=200 4x" width="50" height="50" />
```
### Passing the username as variable
You can also pass the username as a variable, like this:
```
{% assign user="hubot" %}
{% avatar {{ user }} %}
```
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 %}
```
### Lazy loading images
For pages showing a large number of avatars, you may want to load the images lazily.
```liquid
{% avatar hubot lazy=true %}
```
This will set the `data-src` and `data-srcset` attributes on the `<img>` tag, which is compatible with many lazy load JavaScript plugins, such as:
* https://www.andreaverlicchi.eu/lazyload/
* https://appelsiini.net/projects/lazyload/
### 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"`
|
