Verified Commit af24a021 authored by Laurent Heirendt's avatar Laurent Heirendt
Browse files

formatting in development notes

parent 67334d6e
......@@ -30,6 +30,7 @@ Or install it yourself as:
## Plugins
Plugins that are placed in `_plugins` directory **are not published automatically!**. In order to add a new one, add it to [https://git-r3lab.uni.lu/-/ide/project/core-services/jekyll-theme-lcsb-frozen-components](https://git-r3lab.uni.lu/-/ide/project/core-services/jekyll-theme-lcsb-frozen-components).
## Usage
......@@ -37,13 +38,14 @@ Plugins that are placed in `_plugins` directory **are not published automaticall
### 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,
* _new_menu_ to true, if you want to have menu items fully underlined (feel free to check how the site looks with the both options),
* _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
* _baseurl_ entry with the name of your repository,
* _title_ entry with your website's title,
* _email_ entry with your email,
* _new_menu_ to true, if you want to have menu items fully underlined (feel free to check how the site looks with the both options),
* _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.
......@@ -54,11 +56,13 @@ For example, you can copy `index.md` file (and you can refer to its contents as
It should contain the following header:
---
layout: default
title: index
order: 1
---
```markdown
---
layout: default
title: index
order: 1
---
```
* Warning! In case of pages that should be available in the menu, `permalink` item (described below) **IS MANDATORY**.
* Leave layout as `default`.
......@@ -73,7 +77,7 @@ Don't forget to save and commit the file.
There is a special layout type, called `external`. For example, to have a link redirecting you to google.com website, you can create a post with the following contents:
```
```yaml
layout: external
redirect_to: https://www.google.com
title: Title in menu
......@@ -92,7 +96,7 @@ You may also need to disable showing `index.md`, by setting `published: false` i
There are two sections in `_config.yml`, that refer to pagination: first, ` - jekyll-paginate-v2` line in plugins section, and then the configuration dictionary:
```
```yaml
pagination:
enabled: true # Note, that setting it to disabled does not disable it completely, as it has to be also set to false in `pagination.md` file
title: ':title - page :num of :max' # Customize the text
......
Markdown is supported
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