Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
jekyll-theme-lcsb-frozen-components
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Wiki
Requirements
External wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
R3
outreach
themes
jekyll-theme-lcsb-frozen-components
Commits
1ddb97e6
Commit
1ddb97e6
authored
5 years ago
by
Jacek Lebioda
Browse files
Options
Downloads
Patches
Plain Diff
Update README.md
parent
a5a1670e
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+48
-6
48 additions, 6 deletions
README.md
with
48 additions
and
6 deletions
README.md
+
48
−
6
View file @
1ddb97e6
# 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
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment