Verified Commit 67334d6e authored by Laurent Heirendt's avatar Laurent Heirendt
Browse files

show development page in theme

parent e44789ba
---
layout: frozen
title: development
order: 5
---
# Note
This notes are intended for developers of the theme, and **not the developers of the website that use the theme**!
......@@ -32,18 +38,18 @@ Plugins that are placed in `_plugins` directory **are not published automaticall
Open the `_config.yml` file.
Update:
* _baseurl_ entry with the name of your repository,
* _title_ entry with your website's title,
* _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.
### How to add new pages to the website?
Create a new `.md` file inside the project's directory.
Create a new `.md` file inside the project's directory.
For example, you can copy `index.md` file (and you can refer to its contents as to a valid page).
It should contain the following header:
......@@ -53,12 +59,12 @@ It should contain the following header:
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`.
* 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`.
* 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.
......@@ -74,9 +80,9 @@ title: Title in menu
order: 4
```
### 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.
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 and configuring pagination
......@@ -97,7 +103,7 @@ pagination:
sort_reverse: true
trail: # How many pages should be shown in paginator.
before: 2 # Show 2 before the current one, e.g. `< 5 6 CURRENT ...`
after: 2 # Show 2 after the current one, e.g. `... CURRENT 6 7 >`
after: 2 # Show 2 after the current one, e.g. `... CURRENT 6 7 >`
```
To disable it completely, set `enabled` to `false`, remove the aforementioned sections from the configuration, and `gem "jekyll-paginate-v2", "~> 1.7"` from `Gemfile` (from the project's root), and remove `pagination.md` file from project's root directory.
......
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