README.md

jekyll-theme-lcsb-default

Welcome to our LCSB Jekyll theme!

To experiment with this code, add some sample content and run bundle exec jekyll serve – this directory is setup just like a Jekyll site!

This theme is based upon https://github.com/jekyll/minima.

Installation

Add this line to your Jekyll site's Gemfile:

gem "jekyll-theme-lcsb-default"

And add this line to your Jekyll site's _config.yml:

theme: jekyll-theme-lcsb-default

And then execute:

$ bundle

Or install it yourself as:

$ gem install jekyll-theme-lcsb-default

Usage

How to configure your website

Open the _config.yml file. Update:

• baseurl entry with the name of your repository,
• title entry with your website's title,
• email entry with your email,
• date entry to the year you want to appear in the footer,
• (optional) banner to the name of the folder containing banner images (more later in this readme file)
• (optional) logo to "small" or "big", depending on how wide your banner images are

Save, and commit the file. Every time you commit and push to the repository, the new page will be rebuilt and served.

How to add new pages to the website?

Create a new .md file inside the project's directory. For example, you can copy index.md file (and you can refer to it's contents as to a valid page).

It should contain the following header:

---
layout: default
title: index
order: 1
---

• Leave layout as default.
• The title attribute (here - index) is displayed in the menu, thus rename it to your needs.
• Order attribute (here - 1) decides about the order in the menu - lower numbers come first.
• In addition, you can add permalink attribute, which will cause the page to be accessible by the given permalink. For example : permalink: /something/ refers to https://your-webpage-address.com/something.

Don't forget to save and commit the file.

Customise images in the header

Create a folder in assets/banners directory, with banner.svg, logos.svg and motto.svg files (for reference, consult assets/banners/frozen directory. Do not exceed image dimensions). Update _config.yml file with the name of directory you created for the images. In case logos.svg file is wide, change logo: small to logo: big in _config.yml.

Enabling Google Analytics

To enable Google Anaytics, add the following lines to your Jekyll site:

  google_analytics: UA-NNNNNNNN-N

Contributing

Bug reports and pull requests are welcome on Gitlab at https://git-r3lab.uni.lu/core-services/jekyll-theme-lcsb-default/issues. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Development

To set up your environment to develop this theme, run bundle install.

Your theme is setup just like a normal Jekyll site! To test your theme, run bundle exec jekyll serve and open your browser at http://localhost:4000. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.

When your theme is released, only the files in _layouts, _includes, _sass and assets tracked with Git will be bundled. To add a custom directory to your theme-gem, please edit the regexp in jekyll-theme-lcsb-default.gemspec accordingly.

License

The theme is available as open source under the terms of the MIT License.