jekyll-theme-cayman-blog 0.0.6 → 0.0.7
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/404.md +10 -10
- data/LICENSE +116 -116
- data/README.md +203 -203
- data/_includes/site-header.html +38 -38
- data/_includes/social-metatags.html +36 -46
- data/_layouts/default.html +136 -136
- data/_layouts/home.html +30 -30
- data/_layouts/page.html +10 -10
- data/_layouts/post.html +25 -25
- data/_sass/blog.scss +48 -48
- data/_sass/blog/_base.scss +30 -30
- data/_sass/blog/_layout.scss +142 -142
- data/_sass/jekyll-theme-cayman-blog.scss +434 -434
- data/_sass/normalize.scss +424 -424
- data/_sass/rouge-github.scss +209 -209
- data/_sass/variables.scss +23 -23
- data/about.md +13 -13
- data/assets/css/style.scss +4 -4
- data/contact.md +9 -14
- data/index.md +17 -17
- metadata +21 -7
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: c19b6888929c4b0bea320b8a9171e9f13a8f7518
|
|
4
|
+
data.tar.gz: f46f74e0318b0b5faf78fc194d2e89ddfa9dc038
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: f68ee7c5f681ddc9e69694b58b8fcac6540d2870185db835d7da63a2b6a56abadee6ac871ead8a944b47d45ed5abb81dad800c97dd9215eb65eb750840e3557e
|
|
7
|
+
data.tar.gz: 42db19d7ead49f2eaeadac0e0834a90d5ac3e6a05262475aada22c21c72e1c9eb2670d92a15afaad26837d12a8b5afcd754119c2ca3c0caa3c51141ded735048
|
data/404.md
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
---
|
|
2
|
-
layout: page
|
|
3
|
-
title: 404 Error
|
|
4
|
-
tagline: Ah snap! We could not find what you are looking for!
|
|
5
|
-
permalink: /404.html
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
Try got get back to the Home Page and start over!
|
|
9
|
-
|
|
10
|
-
[Go to the Home Page](
|
|
1
|
+
---
|
|
2
|
+
layout: page
|
|
3
|
+
title: 404 Error
|
|
4
|
+
tagline: Ah snap! We could not find what you are looking for!
|
|
5
|
+
permalink: /404.html
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
Try got get back to the Home Page and start over!
|
|
9
|
+
|
|
10
|
+
[Go to the Home Page]({{ site.url }}{{ site.baseurl }})
|
data/LICENSE
CHANGED
|
@@ -1,116 +1,116 @@
|
|
|
1
|
-
CC0 1.0 Universal
|
|
2
|
-
|
|
3
|
-
Statement of Purpose
|
|
4
|
-
|
|
5
|
-
The laws of most jurisdictions throughout the world automatically confer
|
|
6
|
-
exclusive Copyright and Related Rights (defined below) upon the creator and
|
|
7
|
-
subsequent owner(s) (each and all, an "owner") of an original work of
|
|
8
|
-
authorship and/or a database (each, a "Work").
|
|
9
|
-
|
|
10
|
-
Certain owners wish to permanently relinquish those rights to a Work for the
|
|
11
|
-
purpose of contributing to a commons of creative, cultural and scientific
|
|
12
|
-
works ("Commons") that the public can reliably and without fear of later
|
|
13
|
-
claims of infringement build upon, modify, incorporate in other works, reuse
|
|
14
|
-
and redistribute as freely as possible in any form whatsoever and for any
|
|
15
|
-
purposes, including without limitation commercial purposes. These owners may
|
|
16
|
-
contribute to the Commons to promote the ideal of a free culture and the
|
|
17
|
-
further production of creative, cultural and scientific works, or to gain
|
|
18
|
-
reputation or greater distribution for their Work in part through the use and
|
|
19
|
-
efforts of others.
|
|
20
|
-
|
|
21
|
-
For these and/or other purposes and motivations, and without any expectation
|
|
22
|
-
of additional consideration or compensation, the person associating CC0 with a
|
|
23
|
-
Work (the "Affirmer"), to the extent that he or she is an owner of Copyright
|
|
24
|
-
and Related Rights in the Work, voluntarily elects to apply CC0 to the Work
|
|
25
|
-
and publicly distribute the Work under its terms, with knowledge of his or her
|
|
26
|
-
Copyright and Related Rights in the Work and the meaning and intended legal
|
|
27
|
-
effect of CC0 on those rights.
|
|
28
|
-
|
|
29
|
-
1. Copyright and Related Rights. A Work made available under CC0 may be
|
|
30
|
-
protected by copyright and related or neighboring rights ("Copyright and
|
|
31
|
-
Related Rights"). Copyright and Related Rights include, but are not limited
|
|
32
|
-
to, the following:
|
|
33
|
-
|
|
34
|
-
i. the right to reproduce, adapt, distribute, perform, display, communicate,
|
|
35
|
-
and translate a Work;
|
|
36
|
-
|
|
37
|
-
ii. moral rights retained by the original author(s) and/or performer(s);
|
|
38
|
-
|
|
39
|
-
iii. publicity and privacy rights pertaining to a person's image or likeness
|
|
40
|
-
depicted in a Work;
|
|
41
|
-
|
|
42
|
-
iv. rights protecting against unfair competition in regards to a Work,
|
|
43
|
-
subject to the limitations in paragraph 4(a), below;
|
|
44
|
-
|
|
45
|
-
v. rights protecting the extraction, dissemination, use and reuse of data in
|
|
46
|
-
a Work;
|
|
47
|
-
|
|
48
|
-
vi. database rights (such as those arising under Directive 96/9/EC of the
|
|
49
|
-
European Parliament and of the Council of 11 March 1996 on the legal
|
|
50
|
-
protection of databases, and under any national implementation thereof,
|
|
51
|
-
including any amended or successor version of such directive); and
|
|
52
|
-
|
|
53
|
-
vii. other similar, equivalent or corresponding rights throughout the world
|
|
54
|
-
based on applicable law or treaty, and any national implementations thereof.
|
|
55
|
-
|
|
56
|
-
2. Waiver. To the greatest extent permitted by, but not in contravention of,
|
|
57
|
-
applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and
|
|
58
|
-
unconditionally waives, abandons, and surrenders all of Affirmer's Copyright
|
|
59
|
-
and Related Rights and associated claims and causes of action, whether now
|
|
60
|
-
known or unknown (including existing as well as future claims and causes of
|
|
61
|
-
action), in the Work (i) in all territories worldwide, (ii) for the maximum
|
|
62
|
-
duration provided by applicable law or treaty (including future time
|
|
63
|
-
extensions), (iii) in any current or future medium and for any number of
|
|
64
|
-
copies, and (iv) for any purpose whatsoever, including without limitation
|
|
65
|
-
commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes
|
|
66
|
-
the Waiver for the benefit of each member of the public at large and to the
|
|
67
|
-
detriment of Affirmer's heirs and successors, fully intending that such Waiver
|
|
68
|
-
shall not be subject to revocation, rescission, cancellation, termination, or
|
|
69
|
-
any other legal or equitable action to disrupt the quiet enjoyment of the Work
|
|
70
|
-
by the public as contemplated by Affirmer's express Statement of Purpose.
|
|
71
|
-
|
|
72
|
-
3. Public License Fallback. Should any part of the Waiver for any reason be
|
|
73
|
-
judged legally invalid or ineffective under applicable law, then the Waiver
|
|
74
|
-
shall be preserved to the maximum extent permitted taking into account
|
|
75
|
-
Affirmer's express Statement of Purpose. In addition, to the extent the Waiver
|
|
76
|
-
is so judged Affirmer hereby grants to each affected person a royalty-free,
|
|
77
|
-
non transferable, non sublicensable, non exclusive, irrevocable and
|
|
78
|
-
unconditional license to exercise Affirmer's Copyright and Related Rights in
|
|
79
|
-
the Work (i) in all territories worldwide, (ii) for the maximum duration
|
|
80
|
-
provided by applicable law or treaty (including future time extensions), (iii)
|
|
81
|
-
in any current or future medium and for any number of copies, and (iv) for any
|
|
82
|
-
purpose whatsoever, including without limitation commercial, advertising or
|
|
83
|
-
promotional purposes (the "License"). The License shall be deemed effective as
|
|
84
|
-
of the date CC0 was applied by Affirmer to the Work. Should any part of the
|
|
85
|
-
License for any reason be judged legally invalid or ineffective under
|
|
86
|
-
applicable law, such partial invalidity or ineffectiveness shall not
|
|
87
|
-
invalidate the remainder of the License, and in such case Affirmer hereby
|
|
88
|
-
affirms that he or she will not (i) exercise any of his or her remaining
|
|
89
|
-
Copyright and Related Rights in the Work or (ii) assert any associated claims
|
|
90
|
-
and causes of action with respect to the Work, in either case contrary to
|
|
91
|
-
Affirmer's express Statement of Purpose.
|
|
92
|
-
|
|
93
|
-
4. Limitations and Disclaimers.
|
|
94
|
-
|
|
95
|
-
a. No trademark or patent rights held by Affirmer are waived, abandoned,
|
|
96
|
-
surrendered, licensed or otherwise affected by this document.
|
|
97
|
-
|
|
98
|
-
b. Affirmer offers the Work as-is and makes no representations or warranties
|
|
99
|
-
of any kind concerning the Work, express, implied, statutory or otherwise,
|
|
100
|
-
including without limitation warranties of title, merchantability, fitness
|
|
101
|
-
for a particular purpose, non infringement, or the absence of latent or
|
|
102
|
-
other defects, accuracy, or the present or absence of errors, whether or not
|
|
103
|
-
discoverable, all to the greatest extent permissible under applicable law.
|
|
104
|
-
|
|
105
|
-
c. Affirmer disclaims responsibility for clearing rights of other persons
|
|
106
|
-
that may apply to the Work or any use thereof, including without limitation
|
|
107
|
-
any person's Copyright and Related Rights in the Work. Further, Affirmer
|
|
108
|
-
disclaims responsibility for obtaining any necessary consents, permissions
|
|
109
|
-
or other rights required for any use of the Work.
|
|
110
|
-
|
|
111
|
-
d. Affirmer understands and acknowledges that Creative Commons is not a
|
|
112
|
-
party to this document and has no duty or obligation with respect to this
|
|
113
|
-
CC0 or use of the Work.
|
|
114
|
-
|
|
115
|
-
For more information, please see
|
|
116
|
-
<http://creativecommons.org/publicdomain/zero/1.0/>
|
|
1
|
+
CC0 1.0 Universal
|
|
2
|
+
|
|
3
|
+
Statement of Purpose
|
|
4
|
+
|
|
5
|
+
The laws of most jurisdictions throughout the world automatically confer
|
|
6
|
+
exclusive Copyright and Related Rights (defined below) upon the creator and
|
|
7
|
+
subsequent owner(s) (each and all, an "owner") of an original work of
|
|
8
|
+
authorship and/or a database (each, a "Work").
|
|
9
|
+
|
|
10
|
+
Certain owners wish to permanently relinquish those rights to a Work for the
|
|
11
|
+
purpose of contributing to a commons of creative, cultural and scientific
|
|
12
|
+
works ("Commons") that the public can reliably and without fear of later
|
|
13
|
+
claims of infringement build upon, modify, incorporate in other works, reuse
|
|
14
|
+
and redistribute as freely as possible in any form whatsoever and for any
|
|
15
|
+
purposes, including without limitation commercial purposes. These owners may
|
|
16
|
+
contribute to the Commons to promote the ideal of a free culture and the
|
|
17
|
+
further production of creative, cultural and scientific works, or to gain
|
|
18
|
+
reputation or greater distribution for their Work in part through the use and
|
|
19
|
+
efforts of others.
|
|
20
|
+
|
|
21
|
+
For these and/or other purposes and motivations, and without any expectation
|
|
22
|
+
of additional consideration or compensation, the person associating CC0 with a
|
|
23
|
+
Work (the "Affirmer"), to the extent that he or she is an owner of Copyright
|
|
24
|
+
and Related Rights in the Work, voluntarily elects to apply CC0 to the Work
|
|
25
|
+
and publicly distribute the Work under its terms, with knowledge of his or her
|
|
26
|
+
Copyright and Related Rights in the Work and the meaning and intended legal
|
|
27
|
+
effect of CC0 on those rights.
|
|
28
|
+
|
|
29
|
+
1. Copyright and Related Rights. A Work made available under CC0 may be
|
|
30
|
+
protected by copyright and related or neighboring rights ("Copyright and
|
|
31
|
+
Related Rights"). Copyright and Related Rights include, but are not limited
|
|
32
|
+
to, the following:
|
|
33
|
+
|
|
34
|
+
i. the right to reproduce, adapt, distribute, perform, display, communicate,
|
|
35
|
+
and translate a Work;
|
|
36
|
+
|
|
37
|
+
ii. moral rights retained by the original author(s) and/or performer(s);
|
|
38
|
+
|
|
39
|
+
iii. publicity and privacy rights pertaining to a person's image or likeness
|
|
40
|
+
depicted in a Work;
|
|
41
|
+
|
|
42
|
+
iv. rights protecting against unfair competition in regards to a Work,
|
|
43
|
+
subject to the limitations in paragraph 4(a), below;
|
|
44
|
+
|
|
45
|
+
v. rights protecting the extraction, dissemination, use and reuse of data in
|
|
46
|
+
a Work;
|
|
47
|
+
|
|
48
|
+
vi. database rights (such as those arising under Directive 96/9/EC of the
|
|
49
|
+
European Parliament and of the Council of 11 March 1996 on the legal
|
|
50
|
+
protection of databases, and under any national implementation thereof,
|
|
51
|
+
including any amended or successor version of such directive); and
|
|
52
|
+
|
|
53
|
+
vii. other similar, equivalent or corresponding rights throughout the world
|
|
54
|
+
based on applicable law or treaty, and any national implementations thereof.
|
|
55
|
+
|
|
56
|
+
2. Waiver. To the greatest extent permitted by, but not in contravention of,
|
|
57
|
+
applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and
|
|
58
|
+
unconditionally waives, abandons, and surrenders all of Affirmer's Copyright
|
|
59
|
+
and Related Rights and associated claims and causes of action, whether now
|
|
60
|
+
known or unknown (including existing as well as future claims and causes of
|
|
61
|
+
action), in the Work (i) in all territories worldwide, (ii) for the maximum
|
|
62
|
+
duration provided by applicable law or treaty (including future time
|
|
63
|
+
extensions), (iii) in any current or future medium and for any number of
|
|
64
|
+
copies, and (iv) for any purpose whatsoever, including without limitation
|
|
65
|
+
commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes
|
|
66
|
+
the Waiver for the benefit of each member of the public at large and to the
|
|
67
|
+
detriment of Affirmer's heirs and successors, fully intending that such Waiver
|
|
68
|
+
shall not be subject to revocation, rescission, cancellation, termination, or
|
|
69
|
+
any other legal or equitable action to disrupt the quiet enjoyment of the Work
|
|
70
|
+
by the public as contemplated by Affirmer's express Statement of Purpose.
|
|
71
|
+
|
|
72
|
+
3. Public License Fallback. Should any part of the Waiver for any reason be
|
|
73
|
+
judged legally invalid or ineffective under applicable law, then the Waiver
|
|
74
|
+
shall be preserved to the maximum extent permitted taking into account
|
|
75
|
+
Affirmer's express Statement of Purpose. In addition, to the extent the Waiver
|
|
76
|
+
is so judged Affirmer hereby grants to each affected person a royalty-free,
|
|
77
|
+
non transferable, non sublicensable, non exclusive, irrevocable and
|
|
78
|
+
unconditional license to exercise Affirmer's Copyright and Related Rights in
|
|
79
|
+
the Work (i) in all territories worldwide, (ii) for the maximum duration
|
|
80
|
+
provided by applicable law or treaty (including future time extensions), (iii)
|
|
81
|
+
in any current or future medium and for any number of copies, and (iv) for any
|
|
82
|
+
purpose whatsoever, including without limitation commercial, advertising or
|
|
83
|
+
promotional purposes (the "License"). The License shall be deemed effective as
|
|
84
|
+
of the date CC0 was applied by Affirmer to the Work. Should any part of the
|
|
85
|
+
License for any reason be judged legally invalid or ineffective under
|
|
86
|
+
applicable law, such partial invalidity or ineffectiveness shall not
|
|
87
|
+
invalidate the remainder of the License, and in such case Affirmer hereby
|
|
88
|
+
affirms that he or she will not (i) exercise any of his or her remaining
|
|
89
|
+
Copyright and Related Rights in the Work or (ii) assert any associated claims
|
|
90
|
+
and causes of action with respect to the Work, in either case contrary to
|
|
91
|
+
Affirmer's express Statement of Purpose.
|
|
92
|
+
|
|
93
|
+
4. Limitations and Disclaimers.
|
|
94
|
+
|
|
95
|
+
a. No trademark or patent rights held by Affirmer are waived, abandoned,
|
|
96
|
+
surrendered, licensed or otherwise affected by this document.
|
|
97
|
+
|
|
98
|
+
b. Affirmer offers the Work as-is and makes no representations or warranties
|
|
99
|
+
of any kind concerning the Work, express, implied, statutory or otherwise,
|
|
100
|
+
including without limitation warranties of title, merchantability, fitness
|
|
101
|
+
for a particular purpose, non infringement, or the absence of latent or
|
|
102
|
+
other defects, accuracy, or the present or absence of errors, whether or not
|
|
103
|
+
discoverable, all to the greatest extent permissible under applicable law.
|
|
104
|
+
|
|
105
|
+
c. Affirmer disclaims responsibility for clearing rights of other persons
|
|
106
|
+
that may apply to the Work or any use thereof, including without limitation
|
|
107
|
+
any person's Copyright and Related Rights in the Work. Further, Affirmer
|
|
108
|
+
disclaims responsibility for obtaining any necessary consents, permissions
|
|
109
|
+
or other rights required for any use of the Work.
|
|
110
|
+
|
|
111
|
+
d. Affirmer understands and acknowledges that Creative Commons is not a
|
|
112
|
+
party to this document and has no duty or obligation with respect to this
|
|
113
|
+
CC0 or use of the Work.
|
|
114
|
+
|
|
115
|
+
For more information, please see
|
|
116
|
+
<http://creativecommons.org/publicdomain/zero/1.0/>
|
data/README.md
CHANGED
|
@@ -1,203 +1,203 @@
|
|
|
1
|
-
# The Cayman Blog theme
|
|
2
|
-
|
|
3
|
-
[](https://travis-ci.org/lorepirri/cayman-blog) [](https://badge.fury.io/rb/jekyll-theme-cayman-blog)
|
|
4
|
-
|
|
5
|
-
*Cayman Blog is a Jekyll theme for GitHub Pages. It is based on the nice [Cayman theme](https://pages-themes.github.io/cayman/), with blogging features added. You can [preview the theme to see what it looks like](http://lorepirri.github.io/cayman-blog), or even [use it today](#usage).*
|
|
6
|
-
|
|
7
|
-
<img src="thumbnail.png" alt="Thumbnail of cayman-blog" style="max-width:30%; border: 1px solid grey;"/> <img src="thumbnail-mobile.png" alt="Thumbnail of cayman-blog for mobile" style="width: 239px; height: 424px;"/>
|
|
8
|
-
|
|
9
|
-
## Install
|
|
10
|
-
|
|
11
|
-
Cayman Blog Theme has been developed as a Jekyll theme gem for easier use. It is also 100% compatible with GitHub Pages — just with a more involved installation process according to whether you’re _running Jekyll v3.3+ and self-hosting_, or if you’re *hosting with GitHub Pages*.
|
|
12
|
-
|
|
13
|
-
## Self hosting
|
|
14
|
-
|
|
15
|
-
If you’re running Jekyll v3.3+ and **self-hosting** you can quickly install the theme as Ruby gem:
|
|
16
|
-
|
|
17
|
-
1. Add this line to your Jekyll site’s Gemfile:
|
|
18
|
-
|
|
19
|
-
```
|
|
20
|
-
gem "jekyll-theme-cayman-blog"
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
2. Add this line to your Jekyll site’s _config.yml file:
|
|
24
|
-
|
|
25
|
-
```
|
|
26
|
-
theme: jekyll-theme-cayman-blog
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
3. Then run Bundler to install the theme gem and dependencies:
|
|
30
|
-
|
|
31
|
-
```
|
|
32
|
-
script/bootstrap
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
## Hosting with GitHub Pages
|
|
36
|
-
|
|
37
|
-
If you’re *hosting your blog with GitHub Pages* you’ll have to consider this:
|
|
38
|
-
|
|
39
|
-
:warning: As stated in the official [Jekyll documentation](https://jekyllrb.com/docs/themes/#installing-a-theme):
|
|
40
|
-
|
|
41
|
-
> If you’re publishing your Jekyll site on [GitHub Pages](https://pages.github.com/), note that GitHub Pages supports only some gem-based themes. See [Supported Themes](https://pages.github.com/themes/) in GitHub’s documentation to see which themes are supported.
|
|
42
|
-
|
|
43
|
-
Therefore, this theme, as well as many others, can not be installed in the same way as the ones officially supported by GitHub Pages (e.g. Cayman, Minima), a bit more effort has to be put on.
|
|
44
|
-
|
|
45
|
-
The easiest way I found to install _Cayman Blog Theme_, is [installing the theme gem](gem-install), and then [converting the gem-based theme to regular theme](https://jekyllrb.com/docs/themes/#converting-gem-based-themes-to-regular-themes).
|
|
46
|
-
|
|
47
|
-
Alternatively, for new projects, one could fork the whole theme, and keep only the interesting files.
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
### Gem Install
|
|
51
|
-
|
|
52
|
-
This method is preferred for existing _Jekyll blogs_, as well as newly created ones. Notice that the files `index.md`, `about.md`, `contact.md` will be overwritten (only `index.md` is really needed, the other two are just placeholders).
|
|
53
|
-
|
|
54
|
-
1. Install the theme gem: ` $ gem install jekyll-theme-cayman-blog`
|
|
55
|
-
3. Run `$ gem env gemdir` to know where the gem was installed
|
|
56
|
-
4. Open the folder shown in the output
|
|
57
|
-
5. Open the folder `gems`
|
|
58
|
-
5. Open the theme folder (e.g. `jekyll-theme-cayman-blog-0.0.5`)
|
|
59
|
-
6. Copy all the files into your newly created or existing blog folder
|
|
60
|
-
7. Leave empty `theme` your site's `_config.yml`:
|
|
61
|
-
|
|
62
|
-
```yml
|
|
63
|
-
theme:
|
|
64
|
-
```
|
|
65
|
-
6. Modify `_config.yml`, `about.md`, `contact.md` for your project
|
|
66
|
-
7. [Customize the theme](customizing)
|
|
67
|
-
|
|
68
|
-
### Install as a Fork
|
|
69
|
-
|
|
70
|
-
1. [Fork the repo](https://github.com/lorepirri/cayman-blog)
|
|
71
|
-
2. Clone down the repo with `$ git clone git@github.com:username/reponame.git`
|
|
72
|
-
3. Delete the `screenshot.png` and `screenshot-mobile.png` files
|
|
73
|
-
3. Empty the `_posts` folder
|
|
74
|
-
4. Install bundler and gems with `$ script/bootstrap`
|
|
75
|
-
5. Run Jekyll with `$ script/server`
|
|
76
|
-
6. Modify `_config.yml`, `about.md`, `contact.md` for your project
|
|
77
|
-
7. [Customize the theme](customizing)
|
|
78
|
-
|
|
79
|
-
## Customizing
|
|
80
|
-
|
|
81
|
-
### Configuration variables
|
|
82
|
-
|
|
83
|
-
Cayman Blog will respect the following variables, if set in your site's `_config.yml`:
|
|
84
|
-
|
|
85
|
-
```yml
|
|
86
|
-
title: [The title of your site]
|
|
87
|
-
description: [A short description of your site's purpose]
|
|
88
|
-
```
|
|
89
|
-
|
|
90
|
-
Additionally, you may choose to set the following optional variables:
|
|
91
|
-
|
|
92
|
-
```yml
|
|
93
|
-
show_downloads: ["true" or "false" to indicate whether to provide a download URL]
|
|
94
|
-
google_analytics: [Your Google Analytics tracking ID]
|
|
95
|
-
```
|
|
96
|
-
|
|
97
|
-
### RSS feeds
|
|
98
|
-
|
|
99
|
-
To enable RSS feeds and also make visible an RSS feeds button in the footer, the [Jekyll Feed plugin](https://github.com/jekyll/jekyll-feed) must be installed.
|
|
100
|
-
|
|
101
|
-
Add this line to your site's Gemfile:
|
|
102
|
-
|
|
103
|
-
```ruby
|
|
104
|
-
gem 'jekyll-feed'
|
|
105
|
-
```
|
|
106
|
-
|
|
107
|
-
And then add this line to your site's `_config.yml`:
|
|
108
|
-
|
|
109
|
-
```yml
|
|
110
|
-
gems:
|
|
111
|
-
- jekyll-feed
|
|
112
|
-
```
|
|
113
|
-
|
|
114
|
-
For more information about configuring this plugin, see the official [Jekyll Feed plugin](https://github.com/jekyll/jekyll-feed) page.
|
|
115
|
-
|
|
116
|
-
### SEO tags
|
|
117
|
-
|
|
118
|
-
Cayman Blog includes simple SEO tags from [jekyll-social-metatags](https://github.com/lorepirri/jekyll-social-metatags). Have a look at the page for its usage.
|
|
119
|
-
|
|
120
|
-
The usage is compatible with the plugin [Jekyll SEO Tag](https://github.com/jekyll/jekyll-seo-tag), which provides a battle-tested template of crowdsourced best-practices.
|
|
121
|
-
|
|
122
|
-
To switch to a better SEO tags however, one should install [Jekyll Feed plugin](https://github.com/jekyll/jekyll-feed):
|
|
123
|
-
|
|
124
|
-
1. Add this line to your site's Gemfile:
|
|
125
|
-
|
|
126
|
-
```ruby
|
|
127
|
-
gem 'jekyll-seo-tag'
|
|
128
|
-
```
|
|
129
|
-
|
|
130
|
-
2. And then add this line to your site's `_config.yml`:
|
|
131
|
-
|
|
132
|
-
```yml
|
|
133
|
-
gems:
|
|
134
|
-
- jekyll-seo-tag
|
|
135
|
-
```
|
|
136
|
-
|
|
137
|
-
3. Replace with the following, the `<!-- jekyll-seo-tag -->` comment in your site's `default.html`:
|
|
138
|
-
|
|
139
|
-
```liquid
|
|
140
|
-
{% seo %}
|
|
141
|
-
```
|
|
142
|
-
|
|
143
|
-
For more information about configuring this plugin, see the official [Jekyll SEO Tag](https://github.com/jekyll/jekyll-seo-tag) page.
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
### Stylesheet
|
|
147
|
-
|
|
148
|
-
If you'd like to add your own custom styles:
|
|
149
|
-
|
|
150
|
-
1. Create a file called `/assets/css/style.scss` in your site
|
|
151
|
-
2. Add the following content to the top of the file, exactly as shown:
|
|
152
|
-
```scss
|
|
153
|
-
---
|
|
154
|
-
---
|
|
155
|
-
|
|
156
|
-
@import "{{ site.theme }}";
|
|
157
|
-
```
|
|
158
|
-
3. Add any custom CSS (or Sass, including imports) you'd like immediately after the `@import` line
|
|
159
|
-
|
|
160
|
-
### Layouts
|
|
161
|
-
|
|
162
|
-
If you'd like to change the theme's HTML layout:
|
|
163
|
-
|
|
164
|
-
1. [Copy the original template](https://github.com/lorepirri/cayman-blog/blob/master/_layouts/default.html) from the theme's repository<br />(*Pro-tip: click "raw" to make copying easier*)
|
|
165
|
-
2. Create a file called `/_layouts/default.html` in your site
|
|
166
|
-
3. Paste the default layout content copied in the first step
|
|
167
|
-
4. Customize the layout as you'd like
|
|
168
|
-
|
|
169
|
-
### Sass variables
|
|
170
|
-
|
|
171
|
-
If you'd like to change the theme's [Sass variables](https://github.com/lorepirri/cayman-blog/blob/master/_sass/variables.scss), set new values before the `@import` line in your stylesheet:
|
|
172
|
-
|
|
173
|
-
```scss
|
|
174
|
-
$section-headings-color: #0086b3;
|
|
175
|
-
|
|
176
|
-
@import "{{ site.theme }}";
|
|
177
|
-
```
|
|
178
|
-
|
|
179
|
-
## Roadmap
|
|
180
|
-
|
|
181
|
-
See the [open issues](https://github.com/lorepirri/cayman-blog/issues) for a list of proposed features (and known issues).
|
|
182
|
-
|
|
183
|
-
## Project philosophy
|
|
184
|
-
|
|
185
|
-
The Cayman Blog theme is intended to make it quick and easy for GitHub Pages users to create their first (or 100th) website. The theme should meet the vast majority of users' needs out of the box, erring on the side of simplicity rather than flexibility, and provide users the opportunity to opt-in to additional complexity if they have specific needs or wish to further customize their experience (such as adding custom CSS or modifying the default layout). It should also look great, but that goes without saying.
|
|
186
|
-
|
|
187
|
-
## Contributing
|
|
188
|
-
|
|
189
|
-
Interested in contributing to Cayman Blog? We'd love your help. Cayman Blog is an open source project, built one contribution at a time by users like you. See [the CONTRIBUTING file](CONTRIBUTING.md) for instructions on how to contribute.
|
|
190
|
-
|
|
191
|
-
### Previewing the theme locally
|
|
192
|
-
|
|
193
|
-
If you'd like to preview the theme locally (for example, in the process of proposing a change):
|
|
194
|
-
|
|
195
|
-
1. Clone down the theme's repository (`git clone https://github.com/lorepirri/cayman-blog`)
|
|
196
|
-
2. `cd` into the theme's directory
|
|
197
|
-
3. Run `script/bootstrap` to install the necessary dependencies
|
|
198
|
-
4. Run `script/server` to start the preview server
|
|
199
|
-
5. Visit [`localhost:4000`](http://localhost:4000) in your browser to preview the theme
|
|
200
|
-
|
|
201
|
-
### Running tests
|
|
202
|
-
|
|
203
|
-
The theme contains a minimal test suite, to ensure a site with the theme would build successfully. To run the tests, simply run `script/cibuild`. You'll need to run `script/bootstrap` one before the test script will work.
|
|
1
|
+
# The Cayman Blog theme
|
|
2
|
+
|
|
3
|
+
[](https://travis-ci.org/lorepirri/cayman-blog) [](https://badge.fury.io/rb/jekyll-theme-cayman-blog)
|
|
4
|
+
|
|
5
|
+
*Cayman Blog is a Jekyll theme for GitHub Pages. It is based on the nice [Cayman theme](https://pages-themes.github.io/cayman/), with blogging features added. You can [preview the theme to see what it looks like](http://lorepirri.github.io/cayman-blog), or even [use it today](#usage).*
|
|
6
|
+
|
|
7
|
+
<img src="https://raw.githubusercontent.com/lorepirri/cayman-blog/master/thumbnail.png" alt="Thumbnail of cayman-blog" style="max-width:30%; border: 1px solid grey;"/> <img src="https://raw.githubusercontent.com/lorepirri/cayman-blog/master/thumbnail-mobile.png" alt="Thumbnail of cayman-blog for mobile" style="width: 239px; height: 424px;"/>
|
|
8
|
+
|
|
9
|
+
## Install
|
|
10
|
+
|
|
11
|
+
Cayman Blog Theme has been developed as a Jekyll theme gem for easier use. It is also 100% compatible with GitHub Pages — just with a more involved installation process according to whether you’re _running Jekyll v3.3+ and self-hosting_, or if you’re *hosting with GitHub Pages*.
|
|
12
|
+
|
|
13
|
+
## Self hosting
|
|
14
|
+
|
|
15
|
+
If you’re running Jekyll v3.3+ and **self-hosting** you can quickly install the theme as Ruby gem:
|
|
16
|
+
|
|
17
|
+
1. Add this line to your Jekyll site’s Gemfile:
|
|
18
|
+
|
|
19
|
+
```
|
|
20
|
+
gem "jekyll-theme-cayman-blog"
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
2. Add this line to your Jekyll site’s _config.yml file:
|
|
24
|
+
|
|
25
|
+
```
|
|
26
|
+
theme: jekyll-theme-cayman-blog
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
3. Then run Bundler to install the theme gem and dependencies:
|
|
30
|
+
|
|
31
|
+
```
|
|
32
|
+
script/bootstrap
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Hosting with GitHub Pages
|
|
36
|
+
|
|
37
|
+
If you’re *hosting your blog with GitHub Pages* you’ll have to consider this:
|
|
38
|
+
|
|
39
|
+
:warning: As stated in the official [Jekyll documentation](https://jekyllrb.com/docs/themes/#installing-a-theme):
|
|
40
|
+
|
|
41
|
+
> If you’re publishing your Jekyll site on [GitHub Pages](https://pages.github.com/), note that GitHub Pages supports only some gem-based themes. See [Supported Themes](https://pages.github.com/themes/) in GitHub’s documentation to see which themes are supported.
|
|
42
|
+
|
|
43
|
+
Therefore, this theme, as well as many others, can not be installed in the same way as the ones officially supported by GitHub Pages (e.g. Cayman, Minima), a bit more effort has to be put on.
|
|
44
|
+
|
|
45
|
+
The easiest way I found to install _Cayman Blog Theme_, is [installing the theme gem](gem-install), and then [converting the gem-based theme to regular theme](https://jekyllrb.com/docs/themes/#converting-gem-based-themes-to-regular-themes).
|
|
46
|
+
|
|
47
|
+
Alternatively, for new projects, one could fork the whole theme, and keep only the interesting files.
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
### Gem Install
|
|
51
|
+
|
|
52
|
+
This method is preferred for existing _Jekyll blogs_, as well as newly created ones. Notice that the files `index.md`, `about.md`, `contact.md` will be overwritten (only `index.md` is really needed, the other two are just placeholders).
|
|
53
|
+
|
|
54
|
+
1. Install the theme gem: ` $ gem install jekyll-theme-cayman-blog`
|
|
55
|
+
3. Run `$ gem env gemdir` to know where the gem was installed
|
|
56
|
+
4. Open the folder shown in the output
|
|
57
|
+
5. Open the folder `gems`
|
|
58
|
+
5. Open the theme folder (e.g. `jekyll-theme-cayman-blog-0.0.5`)
|
|
59
|
+
6. Copy all the files into your newly created or existing blog folder
|
|
60
|
+
7. Leave empty `theme` your site's `_config.yml`:
|
|
61
|
+
|
|
62
|
+
```yml
|
|
63
|
+
theme:
|
|
64
|
+
```
|
|
65
|
+
6. Modify `_config.yml`, `about.md`, `contact.md` for your project
|
|
66
|
+
7. [Customize the theme](customizing)
|
|
67
|
+
|
|
68
|
+
### Install as a Fork
|
|
69
|
+
|
|
70
|
+
1. [Fork the repo](https://github.com/lorepirri/cayman-blog)
|
|
71
|
+
2. Clone down the repo with `$ git clone git@github.com:username/reponame.git`
|
|
72
|
+
3. Delete the `screenshot.png` and `screenshot-mobile.png` files
|
|
73
|
+
3. Empty the `_posts` folder
|
|
74
|
+
4. Install bundler and gems with `$ script/bootstrap`
|
|
75
|
+
5. Run Jekyll with `$ script/server`
|
|
76
|
+
6. Modify `_config.yml`, `about.md`, `contact.md` for your project
|
|
77
|
+
7. [Customize the theme](customizing)
|
|
78
|
+
|
|
79
|
+
## Customizing
|
|
80
|
+
|
|
81
|
+
### Configuration variables
|
|
82
|
+
|
|
83
|
+
Cayman Blog will respect the following variables, if set in your site's `_config.yml`:
|
|
84
|
+
|
|
85
|
+
```yml
|
|
86
|
+
title: [The title of your site]
|
|
87
|
+
description: [A short description of your site's purpose]
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
Additionally, you may choose to set the following optional variables:
|
|
91
|
+
|
|
92
|
+
```yml
|
|
93
|
+
show_downloads: ["true" or "false" to indicate whether to provide a download URL]
|
|
94
|
+
google_analytics: [Your Google Analytics tracking ID]
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
### RSS feeds
|
|
98
|
+
|
|
99
|
+
To enable RSS feeds and also make visible an RSS feeds button in the footer, the [Jekyll Feed plugin](https://github.com/jekyll/jekyll-feed) must be installed.
|
|
100
|
+
|
|
101
|
+
Add this line to your site's Gemfile:
|
|
102
|
+
|
|
103
|
+
```ruby
|
|
104
|
+
gem 'jekyll-feed'
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
And then add this line to your site's `_config.yml`:
|
|
108
|
+
|
|
109
|
+
```yml
|
|
110
|
+
gems:
|
|
111
|
+
- jekyll-feed
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
For more information about configuring this plugin, see the official [Jekyll Feed plugin](https://github.com/jekyll/jekyll-feed) page.
|
|
115
|
+
|
|
116
|
+
### SEO tags
|
|
117
|
+
|
|
118
|
+
Cayman Blog includes simple SEO tags from [jekyll-social-metatags](https://github.com/lorepirri/jekyll-social-metatags). Have a look at the page for its usage.
|
|
119
|
+
|
|
120
|
+
The usage is compatible with the plugin [Jekyll SEO Tag](https://github.com/jekyll/jekyll-seo-tag), which provides a battle-tested template of crowdsourced best-practices.
|
|
121
|
+
|
|
122
|
+
To switch to a better SEO tags however, one should install [Jekyll Feed plugin](https://github.com/jekyll/jekyll-feed):
|
|
123
|
+
|
|
124
|
+
1. Add this line to your site's Gemfile:
|
|
125
|
+
|
|
126
|
+
```ruby
|
|
127
|
+
gem 'jekyll-seo-tag'
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
2. And then add this line to your site's `_config.yml`:
|
|
131
|
+
|
|
132
|
+
```yml
|
|
133
|
+
gems:
|
|
134
|
+
- jekyll-seo-tag
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
3. Replace with the following, the `<!-- jekyll-seo-tag -->` comment in your site's `default.html`:
|
|
138
|
+
|
|
139
|
+
```liquid
|
|
140
|
+
{% seo %}
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
For more information about configuring this plugin, see the official [Jekyll SEO Tag](https://github.com/jekyll/jekyll-seo-tag) page.
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
### Stylesheet
|
|
147
|
+
|
|
148
|
+
If you'd like to add your own custom styles:
|
|
149
|
+
|
|
150
|
+
1. Create a file called `/assets/css/style.scss` in your site
|
|
151
|
+
2. Add the following content to the top of the file, exactly as shown:
|
|
152
|
+
```scss
|
|
153
|
+
---
|
|
154
|
+
---
|
|
155
|
+
|
|
156
|
+
@import "{{ site.theme }}";
|
|
157
|
+
```
|
|
158
|
+
3. Add any custom CSS (or Sass, including imports) you'd like immediately after the `@import` line
|
|
159
|
+
|
|
160
|
+
### Layouts
|
|
161
|
+
|
|
162
|
+
If you'd like to change the theme's HTML layout:
|
|
163
|
+
|
|
164
|
+
1. [Copy the original template](https://github.com/lorepirri/cayman-blog/blob/master/_layouts/default.html) from the theme's repository<br />(*Pro-tip: click "raw" to make copying easier*)
|
|
165
|
+
2. Create a file called `/_layouts/default.html` in your site
|
|
166
|
+
3. Paste the default layout content copied in the first step
|
|
167
|
+
4. Customize the layout as you'd like
|
|
168
|
+
|
|
169
|
+
### Sass variables
|
|
170
|
+
|
|
171
|
+
If you'd like to change the theme's [Sass variables](https://github.com/lorepirri/cayman-blog/blob/master/_sass/variables.scss), set new values before the `@import` line in your stylesheet:
|
|
172
|
+
|
|
173
|
+
```scss
|
|
174
|
+
$section-headings-color: #0086b3;
|
|
175
|
+
|
|
176
|
+
@import "{{ site.theme }}";
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
## Roadmap
|
|
180
|
+
|
|
181
|
+
See the [open issues](https://github.com/lorepirri/cayman-blog/issues) for a list of proposed features (and known issues).
|
|
182
|
+
|
|
183
|
+
## Project philosophy
|
|
184
|
+
|
|
185
|
+
The Cayman Blog theme is intended to make it quick and easy for GitHub Pages users to create their first (or 100th) website. The theme should meet the vast majority of users' needs out of the box, erring on the side of simplicity rather than flexibility, and provide users the opportunity to opt-in to additional complexity if they have specific needs or wish to further customize their experience (such as adding custom CSS or modifying the default layout). It should also look great, but that goes without saying.
|
|
186
|
+
|
|
187
|
+
## Contributing
|
|
188
|
+
|
|
189
|
+
Interested in contributing to Cayman Blog? We'd love your help. Cayman Blog is an open source project, built one contribution at a time by users like you. See [the CONTRIBUTING file](CONTRIBUTING.md) for instructions on how to contribute.
|
|
190
|
+
|
|
191
|
+
### Previewing the theme locally
|
|
192
|
+
|
|
193
|
+
If you'd like to preview the theme locally (for example, in the process of proposing a change):
|
|
194
|
+
|
|
195
|
+
1. Clone down the theme's repository (`git clone https://github.com/lorepirri/cayman-blog`)
|
|
196
|
+
2. `cd` into the theme's directory
|
|
197
|
+
3. Run `script/bootstrap` to install the necessary dependencies
|
|
198
|
+
4. Run `script/server` to start the preview server
|
|
199
|
+
5. Visit [`localhost:4000`](http://localhost:4000) in your browser to preview the theme
|
|
200
|
+
|
|
201
|
+
### Running tests
|
|
202
|
+
|
|
203
|
+
The theme contains a minimal test suite, to ensure a site with the theme would build successfully. To run the tests, simply run `script/cibuild`. You'll need to run `script/bootstrap` one before the test script will work.
|