index.md 3.69 KB
Newer Older
1
2
3
---
---

4
5
# LCSB theme for [Jekyll](https://jekyllrb.com/)
This repository contains a template you should use when creating any Jekyll-based web page for your LCSB-related projects. 
6

7
Jekyll is a *static webpages generator*, which converts markdown files to a website. Coupled with Gitlab-CI, it can generate and host the pages for you in a completely automatic way (based on your commits to Gitlab).
Yohan Jarosz's avatar
Yohan Jarosz committed
8

9
 > The layout **has been already approved** by our Communications Department - you don't need to spend time on web design nor asking for additional approvals.
Jacek Lebioda's avatar
Jacek Lebioda committed
10

11
# 1. How to use it?
Yohan Jarosz's avatar
Yohan Jarosz committed
12

13
14
## How to start a new Jekyll page using our theme?...
The easiest way to start a new Jekyll page is to fork [this repository (containing an empty example page)](https://git-r3lab.uni.lu/core-services/pages-jekyll-lcsb-template).
Yohan Jarosz's avatar
Yohan Jarosz committed
15

16
The webpage will be published automatically under uni.lu network once you fork the repository - you don't need to open any tickets.
17

18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
After you have forked the repository, you should fill it with your content (either using Gitlab IDE, or cloning the repository and using your favourite Markdown editor) and push the changes using Git.

For more detailed information on all the steps and a guide, please refer to [https://git-r3lab.uni.lu/core-services/pages-jekyll-lcsb-template/blob/master/index.md](https://git-r3lab.uni.lu/core-services/pages-jekyll-lcsb-template/blob/master/index.md).

## ... or how to use the LCSB theme in your existing Jekyll page?
1. Put the following lines in your project's Gemfile: 
    ```
    gem 'jekyll-theme-lcsb-default', '~> 0.4.7'

    gem 'jekyll-theme-lcsb-frozen-components', 
        '~> 0.0.2', 
        :git => "https://git-r3lab.uni.lu/core-services/jekyll-theme-lcsb-frozen-components.git", 
        :tag => "0.0.2"
    ```
2. Specify the theme in your project's `_config.yml` file:
    ```
Jacek Lebioda's avatar
Jacek Lebioda committed
34
35
36
    theme: jekyll-theme-lcsb-default
    plugins:
      - jekyll-theme-lcsb-frozen-components
37
    ```
Jacek Lebioda's avatar
Jacek Lebioda committed
38
39
3. Run `bundle install` to fetch the theme.
4. You're all set!
40
41
42
43
44
45
46
47
48

> Please note, that unless you want to work directly on the theme, you should not use/clone this repository (`jekyll-theme-lcsb-default`) but use `pages-jekyll-lcsb-template` instead.

# 2. Theme development
Please check a separate guide about developing and maintaining the theme, which is available under: [https://git-r3lab.uni.lu/core-services/jekyll-theme-lcsb-default/blob/master/development.md](https://git-r3lab.uni.lu/core-services/jekyll-theme-lcsb-default/blob/master/development.md).

## Branches
 * **latest** contains latest version
 * **master** contains old, legacy version - it might be used by some old projects
Jacek Lebioda's avatar
Jacek Lebioda committed
49

50
## Contributing
Jacek Lebioda's avatar
Jacek Lebioda committed
51
Bug reports and pull requests are welcome on Gitlab at [https://git-r3lab.uni.lu/core-services/jekyll-theme-lcsb-default/issues](https://git-r3lab.uni.lu/core-services/jekyll-theme-lcsb-default/issues). 
Jacek Lebioda's avatar
Jacek Lebioda committed
52

53
54
[Please click here to open a new issue](https://git-r3lab.uni.lu/core-services/jekyll-theme-lcsb-default/-/issues/new?issue).

Jacek Lebioda's avatar
Jacek Lebioda committed
55
This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
56

57
58
59
60
61
## Contributors
The people actively engaged in the development are:
 * Jacek Lebioda ([jacek.lebioda@uni.lu](mailto:jacek.lebioda@uni.lu))
 * Laurent Heirendt
 * Yohan Jarosz
62

63
64
65
66
We've accepted contributions from:
 * Christophe Trefois
 * Elisabeth Guerard
 * Mirek Kratochvil
67

68
69
70
71
# 3. Contact
In case you need any information or help, please don't hesitate to contact [LCSB Sysadmins Team (lcsb-sysadmins@uni.lu)](mailto:lcsb-sysadmins@uni.lu) or the active developers.
# 4. License
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).