Commit 1ddb97e6 authored by Jacek Lebioda's avatar Jacek Lebioda
Browse files

Update README.md

parent a5a1670e
# Frozen components # Frozen components
## What is that? ## What is that?
A collection of plugins that allow the user to include components from _frozen-pages_ layout A collection of Jekyll plugins (tags and filters) that allow the user to include components from _frozen-pages_ layout seamlessly.
## How to use? ## How to use?
**Note, that this repository does not contain CSS files!** They stay within the theme. 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:
More information to be added. ```
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`.
## License ## License
**Apache2**, see LICENSE **Apache2**, see LICENSE
## Contributing
To be filled in
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment