diff --git a/README.md b/README.md index 948fcbacf56cdd7ed3f350ed039b7aaf8c3ec4eb..9375422035343c99ed3175f35aecfb09e9d92fa9 100644 --- a/README.md +++ b/README.md @@ -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): ``` -image: ruby:2.3 +image: ruby:2.5 variables: JEKYLL_ENV: production @@ -69,6 +69,10 @@ pages: - master ``` +## Configuration + +You have some variables that you need to override in the `_config.yaml` file. + ## Using Jekyll locally To work locally with this project, you'll have to follow the steps below: diff --git a/_config.yml b/_config.yml index a71ffab13757f57c05731c90d52217ea2978dc2f..0c6b1cdedd47a6624dae9d3f0d6a097508f677d9 100644 --- a/_config.yml +++ b/_config.yml @@ -13,7 +13,7 @@ # 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 # in the templates via {{ site.myvariable }}. -title: Default title +title: Blank template using LCSB theme. email: your-email@example.com description: >- # this means to ignore newlines until "baseurl:" 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:" Google search results) and in your feed.xml site description. 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 + #twitter_username: jekyllrb #github_username: jekyll diff --git a/about.md b/about.md index 8b4e0b28c83e707c74fcfc6a53f3f084033cfd58..e258288270a9dbcd1e2b229a47660835fc0bca02 100644 --- a/about.md +++ b/about.md @@ -4,15 +4,7 @@ title: 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: -[jekyll][jekyll-organization] / -[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 +You can find the source code for this them at Gitlab: +[core-services/jekyll-theme-lcsb-default](https://git-r3lab.uni.lu/core-services/jekyll-theme-lcsb-default). diff --git a/help.md b/help.md new file mode 100644 index 0000000000000000000000000000000000000000..73f9a0d71ff85d289bfccbc5e31d5a7526bf0d2c --- /dev/null +++ b/help.md @@ -0,0 +1,7 @@ +--- +layout: page +title: Help +permalink: /the-help/ +--- + +This is the `help` page. \ No newline at end of file diff --git a/index.md b/index.md index 96e49982d1220be0776d1a86b25af05e966b3ab6..38a4fb6ee2d4de79b2b97c9c8eeed4a84aecebfe 100644 --- a/index.md +++ b/index.md @@ -5,4 +5,7 @@ layout: default --- -This is the `index` page. \ No newline at end of file +This is the `default lcsb theme` for gitlab pages. + + +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