Commit 8872aa12 authored by Yohan Jarosz's avatar Yohan Jarosz
Browse files

modify readme

parent 3009f722
...@@ -53,7 +53,7 @@ This project's static Pages are built by [GitLab CI][ci], following the steps ...@@ -53,7 +53,7 @@ This project's static Pages are built by [GitLab CI][ci], following the steps
defined in [`.gitlab-ci.yml`](.gitlab-ci.yml): defined in [`.gitlab-ci.yml`](.gitlab-ci.yml):
``` ```
image: ruby:2.3 image: ruby:2.5
variables: variables:
JEKYLL_ENV: production JEKYLL_ENV: production
...@@ -69,6 +69,10 @@ pages: ...@@ -69,6 +69,10 @@ pages:
- master - master
``` ```
## Configuration
You have some variables that you need to override in the `_config.yaml` file.
## Using Jekyll locally ## Using Jekyll locally
To work locally with this project, you'll have to follow the steps below: To work locally with this project, you'll have to follow the steps below:
......
...@@ -13,7 +13,7 @@ ...@@ -13,7 +13,7 @@
# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on. # you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
# You can create any custom variable you would like, and they will be accessible # You can create any custom variable you would like, and they will be accessible
# in the templates via {{ site.myvariable }}. # in the templates via {{ site.myvariable }}.
title: Default title title: Blank template using LCSB theme.
email: your-email@example.com email: your-email@example.com
description: >- # this means to ignore newlines until "baseurl:" description: >- # this means to ignore newlines until "baseurl:"
Write an awesome description for your new site here. You can edit this Write an awesome description for your new site here. You can edit this
...@@ -21,6 +21,7 @@ description: >- # this means to ignore newlines until "baseurl:" ...@@ -21,6 +21,7 @@ description: >- # this means to ignore newlines until "baseurl:"
Google search results) and in your feed.xml site description. Google search results) and in your feed.xml site description.
baseurl: "/pages-jekyll-lcsb-template" # the subpath of your site, e.g. /blog baseurl: "/pages-jekyll-lcsb-template" # the subpath of your site, e.g. /blog
url: "" # the base hostname & protocol for your site, e.g. http://example.com url: "" # the base hostname & protocol for your site, e.g. http://example.com
#twitter_username: jekyllrb #twitter_username: jekyllrb
#github_username: jekyll #github_username: jekyll
......
...@@ -4,15 +4,7 @@ title: About ...@@ -4,15 +4,7 @@ title: About
permalink: /about/ permalink: /about/
--- ---
This is the base Jekyll theme. You can find out more info about customizing your Jekyll theme, as well as basic Jekyll usage documentation at [jekyllrb.com](https://jekyllrb.com/) This is the LCSB Jekyll theme. You can find out more info about customizing your Jekyll theme, as well as basic Jekyll usage documentation at [jekyllrb.com](https://jekyllrb.com/)
You can find the source code for Minima at GitHub: You can find the source code for this them at Gitlab:
[jekyll][jekyll-organization] / [core-services/jekyll-theme-lcsb-default](https://git-r3lab.uni.lu/core-services/jekyll-theme-lcsb-default).
[minima](https://github.com/jekyll/minima)
You can find the source code for Jekyll at GitHub:
[jekyll][jekyll-organization] /
[jekyll](https://github.com/jekyll/jekyll)
[jekyll-organization]: https://github.com/jekyll
---
layout: page
title: Help
permalink: /the-help/
---
This is the `help` page.
\ No newline at end of file
...@@ -5,4 +5,7 @@ ...@@ -5,4 +5,7 @@
layout: default layout: default
--- ---
This is the `index` page. This is the `default lcsb theme` for gitlab pages.
\ No newline at end of file
You can follow the [documentation](https://git-r3lab.uni.lu/core-services/pages-jekyll-lcsb-template/blob/master/README.md) to understand how to use it.
\ No newline at end of file
Supports Markdown
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