classic-jekyll-theme 0.2.2 → 0.2.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +55 -8
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 73198ae0604e75b93fa500a62356cf0e77dae8b7
|
|
4
|
+
data.tar.gz: 485e36b6bc81afb1ea170faeda2ed8422aa8a141
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d860123bd7ad93615603381dac8081bc9455bf203b15c9e9f1832d5de586ba7ed9d4ee41a73d9c0588a20765c4467daec6371c8b30dc5de64fa58679afd1743e
|
|
7
|
+
data.tar.gz: 645964e01b01b62705fe5916ef03b27de939e756e0dc8a00a98c09a9bdac278bd85a056685c8017ad2f3cc9a78d6f0936109b0ebcce8916ec18635ab7ad609ff
|
data/README.md
CHANGED
|
@@ -1,28 +1,36 @@
|
|
|
1
|
-
|
|
1
|
+
---
|
|
2
|
+
layout: product
|
|
3
|
+
product-category: jekyll
|
|
4
|
+
title: Classic-Jekyll-Theme
|
|
5
|
+
subtitle: User Manual
|
|
6
|
+
# icon: /img/classic-jekyll-theme.png
|
|
7
|
+
permalink: /classic-jekyll-theme/features
|
|
8
|
+
---
|
|
9
|
+
# Classic-Jekyll-Theme
|
|
2
10
|
|
|
3
11
|
Welcome to Classic-Jekyll-Theme. This theme centers around one of the most used website structures on the web. A banner, navigation menu, (up to) three columns and a footer. The design is fully responsive for three different screen widths: wide, medium and narrow. It is probably best shown in an example:
|
|
4
12
|
|
|
5
13
|
Wide:
|
|
6
14
|
|
|
7
|
-
|
|
8
16
|
|
|
9
17
|
Medium:
|
|
10
18
|
|
|
11
|
-
|
|
12
20
|
|
|
13
21
|
Narrow:
|
|
14
22
|
|
|
15
|
-
|
|
16
24
|
|
|
17
25
|
The columns are called Primary (blue), Secondary (grey) and Tertiary (pink). In the above layouts the secondary column is on the left side. If it had been on the right side, the medium layout would have looked like this:
|
|
18
26
|
|
|
19
|
-
|
|
20
28
|
|
|
21
29
|
The menu bar (in yellow) is always deployed in the wide layout. In the medium and narrow layout the menu bar is shown in the deployed state. When not deployed, a menu-item symbol is shown in the banner that switches the menu between deployed and not.
|
|
22
30
|
|
|
23
31
|
An example screenshot:
|
|
24
32
|
|
|
25
|
-
|
|
26
34
|
|
|
27
35
|
The navigation bar is created automatically from the available pages when they have the proper YAML frontmatter. The navigation bar contains the top level menu items, while the submenu items show up as a drop-down menu when the cursor hovers over the corresponding menu item.
|
|
28
36
|
|
|
@@ -91,7 +99,7 @@ Reload the website, and the columns will show up.
|
|
|
91
99
|
|
|
92
100
|
To add sample content that illustrates how pages and categories are implemented, copy the folder `pages` from the gem to the current project. On MacOS the gems are located in: `Library/Ruby/Gems/<version>/gems/classic-jekyll-theme-<version>`. Replace the <version>'s with the appropriate numbers (note: these are two different unrelated version numbers). These pages not only contain examples, but also some additional information about using the theme.
|
|
93
101
|
|
|
94
|
-
##
|
|
102
|
+
## Configuration
|
|
95
103
|
|
|
96
104
|
The theme is configured in `_config.yml` and `_sass/classic-jekyll-theme.scss`.
|
|
97
105
|
|
|
@@ -121,13 +129,52 @@ The following values are configurable:
|
|
|
121
129
|
|
|
122
130
|
- enable-cookies-policy:
|
|
123
131
|
|
|
124
|
-
`yes` to enable the cookies warning, `no` to disable.
|
|
132
|
+
`yes` to enable the cookies warning, `no` to disable. The cookies warning is from [Silktide](http://silktide.com/cookieconsent), distributed under the MIT license.
|
|
125
133
|
|
|
126
134
|
|
|
127
135
|
### _sass/classic-jekyll-theme.scss
|
|
128
136
|
|
|
129
137
|
The default `main.scss` file has been emptied. Hence all CSS configuration is done in the theme sass file.
|
|
130
138
|
|
|
139
|
+
## Creating Posts
|
|
140
|
+
|
|
141
|
+
Posting is done exactly like in the standard Jekyll environment.
|
|
142
|
+
|
|
143
|
+
## Creating a Category Page
|
|
144
|
+
|
|
145
|
+
A category page is a page that contains links to all posts published in that category.
|
|
146
|
+
|
|
147
|
+
To kick-off the creation of a category page, create a new page and include the following front matter:
|
|
148
|
+
|
|
149
|
+
---
|
|
150
|
+
layout: category-page
|
|
151
|
+
title: classic
|
|
152
|
+
---
|
|
153
|
+
|
|
154
|
+
The rest of the page can remain empty, it will be automatically created. The _category-page_ triggers the generation of a category page. The _title_ is the category the page is created for. The category (and thus also the _title_) are case sensitive.
|
|
155
|
+
|
|
156
|
+
## Creating Pages for the menu bar
|
|
157
|
+
|
|
158
|
+
To create a page that must be included in the menu bar, add the following front matter to that page:
|
|
159
|
+
|
|
160
|
+
---
|
|
161
|
+
...
|
|
162
|
+
menuInclude: yes
|
|
163
|
+
menuTitle: "About Pages"
|
|
164
|
+
subMenuFrom: Classic
|
|
165
|
+
menuIndex: 2
|
|
166
|
+
---
|
|
167
|
+
|
|
168
|
+
- menuInclude: Set to "yes" to link this page from the menu bar.
|
|
169
|
+
- menuTitle: The title that will be used in the menu bar.
|
|
170
|
+
- menuIndex: The place of the title within the menu bar. For top level menu items, lower numbers will be to the left of higher numbers. For sub-menu items, lower numbers will go above higher numbers. This theme only sorts on menuIndex numbers, not on other properties.
|
|
171
|
+
- subMenuFrom:
|
|
172
|
+
- If absent, the page will be linked from a top level menu item. Top level menu items will always be visible when the menu bar is visible.
|
|
173
|
+
- If a subMenuFrom value is present, and there is a matching page with this value as its menuTitle, then this page will be linked from a drop-down (sub) menu item below that top level menu item.
|
|
174
|
+
- If a subMenuFrom value is present, and there is no matching page with this value as its menuTitle, then a top level menu item will be created with this as its title. This page will be linked from a drop down (sub) menu item below that menu item.
|
|
175
|
+
|
|
176
|
+
For a consistent user experience in the narrow layout, it is recommened not to link pages to top level menu items if these menu items have a drop-down submenu.
|
|
177
|
+
|
|
131
178
|
## Feedback
|
|
132
179
|
|
|
133
180
|
Comments, bug reports, feature requests and improvements are eagerly anticipated via email: rien@balancingrock.nl.
|