README.md 1.42 KB
Newer Older
Jacek Lebioda's avatar
Jacek Lebioda committed
1
2
3
# Frozen components

## What is that?
Jacek Lebioda's avatar
Jacek Lebioda committed
4
A collection of Jekyll plugins (tags and filters) that allow the user to include components from _frozen-pages_ layout seamlessly.
Jacek Lebioda's avatar
Jacek Lebioda committed
5
6

## How to use?
Jacek Lebioda's avatar
Jacek Lebioda committed
7
8
There are two changes to be made in your Jekyll project in order to use this:
* in `Gemfile`, inside `group :jekyll_plugins do` add the following:
Jacek Lebioda's avatar
Jacek Lebioda committed
9

Jacek Lebioda's avatar
Jacek Lebioda committed
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
```
 gem 'jekyll-theme-lcsb-frozen-components', 
     '~> 0.0.1', 
     :git => "https://git-r3lab.uni.lu/core-services/jekyll-theme-lcsb-frozen-components.git", 
     :branch => "master"
```

Example:

```
group :jekyll_plugins do
 gem "jekyll-paginate-v2", 
     "~> 2",
     :git => "https://github.com/sverrirs/jekyll-paginate-v2.git"

 gem "jekyll-feed", 
     "~> 0.6"

 gem 'jekyll-theme-lcsb-frozen-components', 
     '~> 0.0.1', 
     :git => "https://git-r3lab.uni.lu/core-services/jekyll-theme-lcsb-frozen-components.git", 
     :branch => "master"
end
```

* in `_config.yml`, inside `plugins:`, add the following:

```
  - jekyll-theme-lcsb-frozen-components
```

Example:

```
plugins:
  - jekyll-feed
  - jekyll-paginate-v2
  - jekyll-theme-lcsb-frozen-components
```

## Developer's notes

1. **Note, that this repository does not contain CSS files!** They stay within the theme.
2. The code is contained in `lib` directory
2. When you add a new file containing source code, don't forget to register it in `lib/jekyll-theme-lcsb-frozen-components.rb` with `require`.
Jacek Lebioda's avatar
Jacek Lebioda committed
55

56
57
## License
**Apache2**, see LICENSE