jekyll-theme-munky 0.1.3 → 0.1.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +88 -56
- data/_includes/head.html +6 -0
- data/_includes/seo-tag.html +1 -0
- metadata +3 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 3f203d2b9a224e68949d8e885cc69d0d354c9fb8
|
|
4
|
+
data.tar.gz: 200752bc196ae74e670ebbdd3060dee6a6244985
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: e4b92aea11222c040f602047cee25b2067603dc2fce205c5490cc608c7fa8942fe0676ab39a3fd2e0af18d15afe06ee9685410211bb7ce65351e1c836eda4fc6
|
|
7
|
+
data.tar.gz: 861fe4ead03c6a421146bbf34b087a90dfdd93ab02966045183fdf30ea66008a34771ba9929ec921c4864312a5fbd64cf5dcc12b4691efd0ef3629ec4c3f52ac
|
data/README.md
CHANGED
|
@@ -10,11 +10,7 @@
|
|
|
10
10
|
|
|
11
11
|
* [Installation](#installation)
|
|
12
12
|
* [Getting started](#getting-started)
|
|
13
|
-
* [
|
|
14
|
-
* [Layouts](#layouts)
|
|
15
|
-
* [Includes](#includes)
|
|
16
|
-
* [Sass](#sass)
|
|
17
|
-
* [Assets](#assets)
|
|
13
|
+
* [jekyll-seo-tag plugin](#jekyll-seo-tag-plugin)
|
|
18
14
|
* [Usage](#usage)
|
|
19
15
|
* [General](#general)
|
|
20
16
|
* [Pages](#pages)
|
|
@@ -25,6 +21,11 @@
|
|
|
25
21
|
* [Customization](#customization)
|
|
26
22
|
* [Enabling comments (via Disqus)](#enabling-comments-via-disqus)
|
|
27
23
|
* [Enabling Google Analytics](#enabling-google-analytics)
|
|
24
|
+
* [Contents At-A-Glance](#contents-at-a-glance)
|
|
25
|
+
* [Layouts](#layouts)
|
|
26
|
+
* [Includes](#includes)
|
|
27
|
+
* [Sass](#sass)
|
|
28
|
+
* [Assets](#assets)
|
|
28
29
|
* [Contributing](#contributing)
|
|
29
30
|
* [License](#license)
|
|
30
31
|
|
|
@@ -49,7 +50,7 @@ And then execute:
|
|
|
49
50
|
## Getting started
|
|
50
51
|
|
|
51
52
|
Wether you're using munky as a theme gem or as a fork, the easiest way to
|
|
52
|
-
get started is to copy the content from the `demo` folder to your jekyll
|
|
53
|
+
get started is to copy the content from the [`demo`](demo) folder to your jekyll
|
|
53
54
|
website's root folder. It adds all the required files and settings
|
|
54
55
|
to get the most of out of the theme and adds some example data to get started.
|
|
55
56
|
|
|
@@ -82,62 +83,35 @@ defaults:
|
|
|
82
83
|
type: "project"
|
|
83
84
|
```
|
|
84
85
|
|
|
85
|
-
##
|
|
86
|
+
## jekyll-seo-tag plugin
|
|
86
87
|
|
|
87
|
-
|
|
88
|
+
Although not a requirement to run the theme, Munky is build with
|
|
89
|
+
[jekyll-seo-tag](https://github.com/jekyll/jekyll-seo-tag) integration in mind.
|
|
90
|
+
What this means is that many of the FrontMatter variables used by the theme are
|
|
91
|
+
the same ones jekyll-seo-tag uses to build it's metadata tags.
|
|
88
92
|
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
- `default.html` — The base layout that lays the foundation for subsequent layouts. The derived layouts inject their contents into this file at the line that says ` {{ content }} ` and are linked to this file via [FrontMatter](https://jekyllrb.com/docs/frontmatter/) declaration `layout: default`.
|
|
92
|
-
- `home.html` — The layout for your landing-page / home-page / index-page.
|
|
93
|
-
- `page.html` — The layout for your documents that contain FrontMatter, but are not posts.
|
|
94
|
-
- `post.html` — The layout for your posts and projects.
|
|
95
|
-
- `about.html` — The layout for your about-page.
|
|
96
|
-
- `photography.html` — The layout for your photography-page.
|
|
97
|
-
- `projects.html` — The layout for your projects-page.
|
|
98
|
-
|
|
99
|
-
### Includes
|
|
100
|
-
|
|
101
|
-
Refers to snippets of code within the `_includes` directory that can be inserted in multiple layouts (and another include-file as well) within the same theme-gem.
|
|
102
|
-
|
|
103
|
-
- `disqus_comments.html` — Code to markup disqus comment box.
|
|
104
|
-
- `footer.html` — Defines the site's footer section.
|
|
105
|
-
- `google-analytics.html` — Inserts Google Analytics module (active only in production environment).
|
|
106
|
-
- `head.html` — Code-block that defines the `<head></head>` in *default* layout.
|
|
107
|
-
- `header.html` — Defines the site's main header section.
|
|
108
|
-
- `sidebar.html` — Defines the site's sidebar section.
|
|
109
|
-
- `github-buttons.html` — Inserts github repository buttons for projects.
|
|
110
|
-
- `share-buttons.html` — Inserts social media share buttons for projects and posts.
|
|
111
|
-
- `image.html` — Defines how are images defined in markdown are generated.
|
|
93
|
+
To install the plugin add this line to your Jekyll site's Gemfile:
|
|
112
94
|
|
|
113
|
-
|
|
95
|
+
```ruby
|
|
96
|
+
gem 'jekyll-seo-tag'
|
|
97
|
+
```
|
|
114
98
|
|
|
115
|
-
|
|
99
|
+
And add this line to your Jekyll site's `_config.yml`:
|
|
116
100
|
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
-
|
|
101
|
+
```yaml
|
|
102
|
+
gems:
|
|
103
|
+
- jekyll-seo-tag
|
|
104
|
+
```
|
|
120
105
|
|
|
121
|
-
|
|
106
|
+
And then execute:
|
|
122
107
|
|
|
123
|
-
|
|
124
|
-
Contains the `main.scss` that imports sass files from within the `_sass`
|
|
125
|
-
directory. This `main.scss` is what gets processed into the theme's main
|
|
126
|
-
stylesheet `main.css` called by `_layouts/default.html` via `_includes/head.html`.
|
|
108
|
+
$ bundle
|
|
127
109
|
|
|
128
|
-
|
|
129
|
-
|
|
110
|
+
Munky theme will detect the plugin and place the requird `{% seo %}` tag in your
|
|
111
|
+
website's `<head></head>` section.
|
|
130
112
|
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
- `css` — Contains the main `.scss` file as well as the `simplelightbox.scss` file for the configuration of the photo gallery.
|
|
134
|
-
- `downloads` — Place downloadable content for projects in this directory.
|
|
135
|
-
- `fonts` — Contains font-awesome font files for icons.
|
|
136
|
-
- `javascripts` — Directory with jquery, simple-lightbox and custom javascript files.
|
|
137
|
-
- `images` — The root directory contains side wide images such as logos and profile pictures.
|
|
138
|
-
- `photography` — Place photographs with their thumbnails in this directory.
|
|
139
|
-
- `posts` — Images for the posts, each post has his own sub-directory corresponding with the markdown filename.
|
|
140
|
-
- `projects` — Images for the projects, each project has his own sub-directory corresponding with the markdown filename.
|
|
113
|
+
For a more general overview of the plugin, please refer to the
|
|
114
|
+
[jekyll-seo-tag documentation](https://github.com/jekyll/jekyll-seo-tag).
|
|
141
115
|
|
|
142
116
|
## Usage
|
|
143
117
|
|
|
@@ -243,7 +217,8 @@ the following variables:
|
|
|
243
217
|
- gallery
|
|
244
218
|
```
|
|
245
219
|
|
|
246
|
-
The following markdown files
|
|
220
|
+
The following markdown files make up the 4 main sections of the theme. Only
|
|
221
|
+
`index.md` is required:
|
|
247
222
|
|
|
248
223
|
- `index.md` — Layout: *home*
|
|
249
224
|
- `projects.md` — Layout: *projects*
|
|
@@ -280,7 +255,7 @@ Projects use the *post* layout but add some extra features through the following
|
|
|
280
255
|
FrontMatter variables:
|
|
281
256
|
|
|
282
257
|
```yaml
|
|
283
|
-
# The description
|
|
258
|
+
# The description shown on the project overview page.
|
|
284
259
|
description: Ultrices dapibus felis dolor sed, augue scelerisque, ante ligula
|
|
285
260
|
aenean aliquam feugiat eget.
|
|
286
261
|
# Link to the github repository of the project. To use this feature you need
|
|
@@ -289,7 +264,7 @@ FrontMatter variables:
|
|
|
289
264
|
# Only in case the repo is not set, you can use the download variable to link
|
|
290
265
|
# to a file in the /assets/download directory.
|
|
291
266
|
download: example.zip
|
|
292
|
-
# Link to the image
|
|
267
|
+
# Link to the image shown on the project overview page.
|
|
293
268
|
image: /assets/images/projects/example.jpg
|
|
294
269
|
```
|
|
295
270
|
|
|
@@ -390,6 +365,63 @@ To enable Google Anaytics, add the following lines to your Jekyll site's `_confi
|
|
|
390
365
|
|
|
391
366
|
Google Analytics will only appear in production, i.e., `JEKYLL_ENV=production`
|
|
392
367
|
|
|
368
|
+
## Contents At-A-Glance
|
|
369
|
+
|
|
370
|
+
### Layouts
|
|
371
|
+
|
|
372
|
+
Refers to files within the `_layouts` directory, that define the markup for your theme.
|
|
373
|
+
|
|
374
|
+
- `default.html` — The base layout that lays the foundation for subsequent layouts. The derived layouts inject their contents into this file at the line that says ` {{ content }} ` and are linked to this file via [FrontMatter](https://jekyllrb.com/docs/frontmatter/) declaration `layout: default`.
|
|
375
|
+
- `home.html` — The layout for your landing-page / home-page / index-page.
|
|
376
|
+
- `page.html` — The layout for your documents that contain FrontMatter, but are not posts.
|
|
377
|
+
- `post.html` — The layout for your posts and projects.
|
|
378
|
+
- `about.html` — The layout for your about-page.
|
|
379
|
+
- `photography.html` — The layout for your photography-page.
|
|
380
|
+
- `projects.html` — The layout for your projects-page.
|
|
381
|
+
|
|
382
|
+
### Includes
|
|
383
|
+
|
|
384
|
+
Refers to snippets of code within the `_includes` directory that can be inserted in multiple layouts (and another include-file as well) within the same theme-gem.
|
|
385
|
+
|
|
386
|
+
- `disqus_comments.html` — Code to markup disqus comment box.
|
|
387
|
+
- `footer.html` — Defines the site's footer section.
|
|
388
|
+
- `google-analytics.html` — Inserts Google Analytics module (active only in production environment).
|
|
389
|
+
- `head.html` — Code-block that defines the `<head></head>` in *default* layout.
|
|
390
|
+
- `header.html` — Defines the site's main header section.
|
|
391
|
+
- `sidebar.html` — Defines the site's sidebar section.
|
|
392
|
+
- `github-buttons.html` — Inserts github repository buttons for projects.
|
|
393
|
+
- `share-buttons.html` — Inserts social media share buttons for projects and posts.
|
|
394
|
+
- `image.html` — Defines how images defined in markdown are generated.
|
|
395
|
+
|
|
396
|
+
### Sass
|
|
397
|
+
|
|
398
|
+
Refers to `.scss` files within the `_sass` directory that define the theme's styles.
|
|
399
|
+
|
|
400
|
+
- `munky.scss` — The core file imported by preprocessed `main.scss`, it defines the variable defaults for the theme and also further imports sass partials to supplement itself.
|
|
401
|
+
- `munky/*.scss` — Sass partials that are imported by `munky.scss`.
|
|
402
|
+
- `font-awesome/font-awesome.scss` — Imports sass partials for font-awesome icons.
|
|
403
|
+
|
|
404
|
+
### Assets
|
|
405
|
+
|
|
406
|
+
Refers to various asset files within the `assets` directory.
|
|
407
|
+
Contains the `main.scss` that imports sass files from within the `_sass`
|
|
408
|
+
directory. This `main.scss` is what gets processed into the theme's main
|
|
409
|
+
stylesheet `main.css` called by `_layouts/default.html` via `_includes/head.html`.
|
|
410
|
+
|
|
411
|
+
This directory can include sub-directories to manage assets of similar type,
|
|
412
|
+
and will be copied over as is, to the final transformed site directory.
|
|
413
|
+
|
|
414
|
+
The following sub-directories are required:
|
|
415
|
+
|
|
416
|
+
- `css` — Contains the main `.scss` file as well as the `simplelightbox.scss` file for the configuration of the photo gallery.
|
|
417
|
+
- `downloads` — Place downloadable content for projects in this directory.
|
|
418
|
+
- `fonts` — Contains font-awesome font files for icons.
|
|
419
|
+
- `javascripts` — Directory with jquery, simple-lightbox and custom javascript files.
|
|
420
|
+
- `images` — The root directory contains side wide images such as logos and profile pictures.
|
|
421
|
+
- `photography` — Place photographs with their thumbnails in this directory.
|
|
422
|
+
- `posts` — Images for posts, each post has his own sub-directory corresponding with its filename.
|
|
423
|
+
- `projects` — Images for projects, each project has his own sub-directory corresponding with its filename.
|
|
424
|
+
|
|
393
425
|
## Contributing
|
|
394
426
|
|
|
395
427
|
Bug reports and pull requests are welcome on GitHub at https://github.com/GeertArien/jekyll-theme-munky.
|
data/_includes/head.html
CHANGED
|
@@ -24,4 +24,10 @@
|
|
|
24
24
|
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
|
|
25
25
|
<![endif]-->
|
|
26
26
|
|
|
27
|
+
{% if site.gems contains "jekyll-seo-tag" %}
|
|
28
|
+
{% include seo-tag.html %}
|
|
29
|
+
{% else %}
|
|
30
|
+
<title>{% if page.title %}{{ page.title | escape }} | {% endif %}{{ site.title | escape }}</title>
|
|
31
|
+
{% endif %}
|
|
32
|
+
|
|
27
33
|
</head>
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{% seo %}
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: jekyll-theme-munky
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.1.
|
|
4
|
+
version: 0.1.4
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Geert Arien
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2017-04-
|
|
11
|
+
date: 2017-04-17 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: jekyll
|
|
@@ -82,6 +82,7 @@ files:
|
|
|
82
82
|
- _includes/head.html
|
|
83
83
|
- _includes/header.html
|
|
84
84
|
- _includes/image.html
|
|
85
|
+
- _includes/seo-tag.html
|
|
85
86
|
- _includes/share_buttons.html
|
|
86
87
|
- _includes/sidebar.html
|
|
87
88
|
- _layouts/about.html
|