Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
core-services
jekyll-theme-lcsb-frozen-components
Commits
e70b724b
Commit
e70b724b
authored
Dec 06, 2019
by
Jacek Lebioda
Browse files
Merge branch '5-update-readme' into 'master'
Update README.md Closes
#5
See merge request
!6
parents
a5a1670e
1ddb97e6
Changes
1
Hide whitespace changes
Inline
Side-by-side
README.md
View file @
e70b724b
# Frozen components
## 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?
**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
**Apache2**
, see LICENSE
## Contributing
To be filled in
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment