jekyll-theme-type-on-strap 6.0.0 → 7.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +97 -36
- data/_data/language.yml +13 -0
- data/_includes/blog.html +14 -8
- data/_includes/blog_nav.html +12 -10
- data/_includes/disqus.html +1 -1
- data/_includes/head.html +19 -33
- data/_includes/icons.html +55 -55
- data/_includes/navbar.html +16 -32
- data/_includes/post_info.html +13 -0
- data/_includes/post_nav.html +17 -16
- data/_includes/share_buttons.html +19 -26
- data/_layouts/feed.xml +9 -3
- data/_layouts/post.html +24 -9
- data/_sass/base/_global.scss +127 -110
- data/_sass/base/_utility.scss +60 -45
- data/_sass/base/_variables.scss +30 -26
- data/_sass/external/_font-awesome.scss +17 -0
- data/_sass/external/_katex.scss +1010 -0
- data/_sass/external/_pacifico.scss +17 -0
- data/{assets/css/vendor/google_fonts.css → _sass/external/_source-sans-pro.scss} +15 -5
- data/_sass/external/_syntax.scss +85 -83
- data/_sass/external/font-awesome/_animated.scss +34 -0
- data/_sass/external/font-awesome/_bordered-pulled.scss +25 -0
- data/_sass/external/font-awesome/_core.scss +12 -0
- data/_sass/external/font-awesome/_fixed-width.scss +6 -0
- data/_sass/external/font-awesome/_icons.scss +789 -0
- data/_sass/external/font-awesome/_larger.scss +13 -0
- data/_sass/external/font-awesome/_list.scss +19 -0
- data/_sass/external/font-awesome/_mixins.scss +60 -0
- data/_sass/external/font-awesome/_path.scss +16 -0
- data/_sass/external/font-awesome/_rotated-flipped.scss +20 -0
- data/_sass/external/font-awesome/_screen-reader.scss +5 -0
- data/_sass/external/font-awesome/_stacked.scss +20 -0
- data/_sass/external/font-awesome/_variables.scss +800 -0
- data/_sass/external/font-awesome/font-awesome.scss +17 -0
- data/_sass/includes/_blog_nav.scss +36 -38
- data/_sass/includes/_footer.scss +19 -16
- data/_sass/includes/_grid.scss +22 -22
- data/_sass/includes/_navbar.scss +117 -128
- data/_sass/includes/_portfolio.scss +40 -39
- data/_sass/includes/_post_nav.scss +28 -23
- data/_sass/includes/_share_buttons.scss +26 -25
- data/_sass/layouts/_blog.scss +103 -0
- data/_sass/layouts/_page.scss +5 -4
- data/_sass/layouts/_posts.scss +102 -96
- data/_sass/layouts/_search.scss +45 -44
- data/_sass/layouts/_tags.scss +43 -34
- data/_sass/type-on-strap.scss +6 -6
- data/assets/css/main.scss +1 -1
- data/assets/css/vendor/bootstrap-iso.css +1387 -468
- data/assets/css/vendor/bootstrap-iso.min.css +5 -5
- data/assets/css/vendor/bootstrap.css +1457 -450
- data/assets/data/search.json +25 -27
- data/assets/fonts/Pacifico/Pacifico.eot +0 -0
- data/assets/fonts/Pacifico/Pacifico.svg +10833 -0
- data/assets/fonts/Pacifico/Pacifico.ttf +0 -0
- data/assets/fonts/Pacifico/Pacifico.woff +0 -0
- data/assets/fonts/Pacifico/Pacifico.woff2 +0 -0
- data/assets/fonts/Pacifico/original-pacifico-regular.ttf +0 -0
- data/assets/fonts/fontawesome/FontAwesome.otf +0 -0
- data/assets/fonts/fontawesome/fontawesome-webfont.eot +0 -0
- data/assets/fonts/fontawesome/fontawesome-webfont.svg +2671 -0
- data/assets/fonts/fontawesome/fontawesome-webfont.ttf +0 -0
- data/assets/fonts/{fontawesome-webfont.woff → fontawesome/fontawesome-webfont.woff} +0 -0
- data/assets/fonts/{fontawesome-webfont.woff2 → fontawesome/fontawesome-webfont.woff2} +0 -0
- data/assets/fonts/katex/KaTeX_AMS-Regular.eot +0 -0
- data/assets/fonts/katex/KaTeX_AMS-Regular.ttf +0 -0
- data/assets/fonts/{KaTeX_AMS-Regular.woff → katex/KaTeX_AMS-Regular.woff} +0 -0
- data/assets/fonts/{KaTeX_AMS-Regular.woff2 → katex/KaTeX_AMS-Regular.woff2} +0 -0
- data/assets/fonts/katex/KaTeX_Caligraphic-Bold.eot +0 -0
- data/assets/fonts/katex/KaTeX_Caligraphic-Bold.ttf +0 -0
- data/assets/fonts/{KaTeX_Caligraphic-Bold.woff → katex/KaTeX_Caligraphic-Bold.woff} +0 -0
- data/assets/fonts/{KaTeX_Caligraphic-Bold.woff2 → katex/KaTeX_Caligraphic-Bold.woff2} +0 -0
- data/assets/fonts/katex/KaTeX_Caligraphic-Regular.eot +0 -0
- data/assets/fonts/katex/KaTeX_Caligraphic-Regular.ttf +0 -0
- data/assets/fonts/{KaTeX_Caligraphic-Regular.woff → katex/KaTeX_Caligraphic-Regular.woff} +0 -0
- data/assets/fonts/{KaTeX_Caligraphic-Regular.woff2 → katex/KaTeX_Caligraphic-Regular.woff2} +0 -0
- data/assets/fonts/katex/KaTeX_Fraktur-Bold.eot +0 -0
- data/assets/fonts/katex/KaTeX_Fraktur-Bold.ttf +0 -0
- data/assets/fonts/{KaTeX_Fraktur-Bold.woff → katex/KaTeX_Fraktur-Bold.woff} +0 -0
- data/assets/fonts/{KaTeX_Fraktur-Bold.woff2 → katex/KaTeX_Fraktur-Bold.woff2} +0 -0
- data/assets/fonts/katex/KaTeX_Fraktur-Regular.eot +0 -0
- data/assets/fonts/katex/KaTeX_Fraktur-Regular.ttf +0 -0
- data/assets/fonts/{KaTeX_Fraktur-Regular.woff → katex/KaTeX_Fraktur-Regular.woff} +0 -0
- data/assets/fonts/{KaTeX_Fraktur-Regular.woff2 → katex/KaTeX_Fraktur-Regular.woff2} +0 -0
- data/assets/fonts/katex/KaTeX_Main-Bold.eot +0 -0
- data/assets/fonts/katex/KaTeX_Main-Bold.ttf +0 -0
- data/assets/fonts/{KaTeX_Main-Bold.woff → katex/KaTeX_Main-Bold.woff} +0 -0
- data/assets/fonts/{KaTeX_Main-Bold.woff2 → katex/KaTeX_Main-Bold.woff2} +0 -0
- data/assets/fonts/katex/KaTeX_Main-Italic.eot +0 -0
- data/assets/fonts/katex/KaTeX_Main-Italic.ttf +0 -0
- data/assets/fonts/{KaTeX_Main-Italic.woff → katex/KaTeX_Main-Italic.woff} +0 -0
- data/assets/fonts/{KaTeX_Main-Italic.woff2 → katex/KaTeX_Main-Italic.woff2} +0 -0
- data/assets/fonts/katex/KaTeX_Main-Regular.eot +0 -0
- data/assets/fonts/katex/KaTeX_Main-Regular.ttf +0 -0
- data/assets/fonts/{KaTeX_Main-Regular.woff → katex/KaTeX_Main-Regular.woff} +0 -0
- data/assets/fonts/{KaTeX_Main-Regular.woff2 → katex/KaTeX_Main-Regular.woff2} +0 -0
- data/assets/fonts/katex/KaTeX_Math-BoldItalic.eot +0 -0
- data/assets/fonts/katex/KaTeX_Math-BoldItalic.ttf +0 -0
- data/assets/fonts/{KaTeX_Math-BoldItalic.woff → katex/KaTeX_Math-BoldItalic.woff} +0 -0
- data/assets/fonts/{KaTeX_Math-BoldItalic.woff2 → katex/KaTeX_Math-BoldItalic.woff2} +0 -0
- data/assets/fonts/katex/KaTeX_Math-Italic.eot +0 -0
- data/assets/fonts/katex/KaTeX_Math-Italic.ttf +0 -0
- data/assets/fonts/{KaTeX_Math-Italic.woff → katex/KaTeX_Math-Italic.woff} +0 -0
- data/assets/fonts/{KaTeX_Math-Italic.woff2 → katex/KaTeX_Math-Italic.woff2} +0 -0
- data/assets/fonts/katex/KaTeX_Math-Regular.eot +0 -0
- data/assets/fonts/katex/KaTeX_Math-Regular.ttf +0 -0
- data/assets/fonts/{KaTeX_Math-Regular.woff → katex/KaTeX_Math-Regular.woff} +0 -0
- data/assets/fonts/{KaTeX_Math-Regular.woff2 → katex/KaTeX_Math-Regular.woff2} +0 -0
- data/assets/fonts/katex/KaTeX_SansSerif-Bold.eot +0 -0
- data/assets/fonts/katex/KaTeX_SansSerif-Bold.ttf +0 -0
- data/assets/fonts/{KaTeX_SansSerif-Bold.woff → katex/KaTeX_SansSerif-Bold.woff} +0 -0
- data/assets/fonts/{KaTeX_SansSerif-Bold.woff2 → katex/KaTeX_SansSerif-Bold.woff2} +0 -0
- data/assets/fonts/katex/KaTeX_SansSerif-Italic.eot +0 -0
- data/assets/fonts/katex/KaTeX_SansSerif-Italic.ttf +0 -0
- data/assets/fonts/{KaTeX_SansSerif-Italic.woff → katex/KaTeX_SansSerif-Italic.woff} +0 -0
- data/assets/fonts/{KaTeX_SansSerif-Italic.woff2 → katex/KaTeX_SansSerif-Italic.woff2} +0 -0
- data/assets/fonts/katex/KaTeX_SansSerif-Regular.eot +0 -0
- data/assets/fonts/katex/KaTeX_SansSerif-Regular.ttf +0 -0
- data/assets/fonts/{KaTeX_SansSerif-Regular.woff → katex/KaTeX_SansSerif-Regular.woff} +0 -0
- data/assets/fonts/{KaTeX_SansSerif-Regular.woff2 → katex/KaTeX_SansSerif-Regular.woff2} +0 -0
- data/assets/fonts/katex/KaTeX_Script-Regular.eot +0 -0
- data/assets/fonts/katex/KaTeX_Script-Regular.ttf +0 -0
- data/assets/fonts/{KaTeX_Script-Regular.woff → katex/KaTeX_Script-Regular.woff} +0 -0
- data/assets/fonts/{KaTeX_Script-Regular.woff2 → katex/KaTeX_Script-Regular.woff2} +0 -0
- data/assets/fonts/katex/KaTeX_Size1-Regular.eot +0 -0
- data/assets/fonts/katex/KaTeX_Size1-Regular.ttf +0 -0
- data/assets/fonts/{KaTeX_Size1-Regular.woff → katex/KaTeX_Size1-Regular.woff} +0 -0
- data/assets/fonts/{KaTeX_Size1-Regular.woff2 → katex/KaTeX_Size1-Regular.woff2} +0 -0
- data/assets/fonts/katex/KaTeX_Size2-Regular.eot +0 -0
- data/assets/fonts/katex/KaTeX_Size2-Regular.ttf +0 -0
- data/assets/fonts/{KaTeX_Size2-Regular.woff → katex/KaTeX_Size2-Regular.woff} +0 -0
- data/assets/fonts/{KaTeX_Size2-Regular.woff2 → katex/KaTeX_Size2-Regular.woff2} +0 -0
- data/assets/fonts/katex/KaTeX_Size3-Regular.eot +0 -0
- data/assets/fonts/katex/KaTeX_Size3-Regular.ttf +0 -0
- data/assets/fonts/{KaTeX_Size3-Regular.woff → katex/KaTeX_Size3-Regular.woff} +0 -0
- data/assets/fonts/{KaTeX_Size3-Regular.woff2 → katex/KaTeX_Size3-Regular.woff2} +0 -0
- data/assets/fonts/katex/KaTeX_Size4-Regular.eot +0 -0
- data/assets/fonts/katex/KaTeX_Size4-Regular.ttf +0 -0
- data/assets/fonts/{KaTeX_Size4-Regular.woff → katex/KaTeX_Size4-Regular.woff} +0 -0
- data/assets/fonts/{KaTeX_Size4-Regular.woff2 → katex/KaTeX_Size4-Regular.woff2} +0 -0
- data/assets/fonts/katex/KaTeX_Typewriter-Regular.eot +0 -0
- data/assets/fonts/katex/KaTeX_Typewriter-Regular.ttf +0 -0
- data/assets/fonts/{KaTeX_Typewriter-Regular.woff → katex/KaTeX_Typewriter-Regular.woff} +0 -0
- data/assets/fonts/{KaTeX_Typewriter-Regular.woff2 → katex/KaTeX_Typewriter-Regular.woff2} +0 -0
- data/assets/fonts/{source-sans-pro-bold-italic.woff2 → source-sans-pro/source-sans-pro-bold-italic.woff2} +0 -0
- data/assets/fonts/{source-sans-pro-bold.woff2 → source-sans-pro/source-sans-pro-bold.woff2} +0 -0
- data/assets/fonts/{source-sans-pro-italic.woff2 → source-sans-pro/source-sans-pro-italic.woff2} +0 -0
- data/assets/fonts/{source-sans-pro-regular.woff2 → source-sans-pro/source-sans-pro-regular.woff2} +0 -0
- data/assets/js/partials/katex_init.js +20 -20
- data/assets/js/partials/masonry_init.js +17 -17
- data/assets/js/partials/navbar.js +18 -18
- data/assets/js/vendor/imagesloaded.min.js +7 -1
- data/assets/js/vendor/katex.min.js +1 -6
- data/assets/js/vendor/masonry.pkgd.min.js +2 -2
- metadata +137 -78
- data/_sass/layouts/_index.scss +0 -103
- data/assets/css/vendor/font-awesome.min.css +0 -4
- data/assets/css/vendor/google_fonts.min.css +0 -1
- data/assets/css/vendor/katex.min.css +0 -1
- data/assets/fonts/.DS_Store +0 -0
- data/assets/fonts/glyphicons-halflings-regular.woff +0 -0
- data/assets/fonts/glyphicons-halflings-regular.woff2 +0 -0
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 6d906fefe33357f8c7e752c62165a3ac3f67b912
|
4
|
+
data.tar.gz: c1ca6553498f10dd4c4b7b9d1bab334a1b7b98fe
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 14c5c23879413584194c4d6e883f625dc1162efcbb538a6b64a0bc9befae234a23d4b7538e784ac0ad817dbb881f963e7b66d33bdf5de52015032aef51983627
|
7
|
+
data.tar.gz: c8b791fbccdf4d2b5c493b26cb02d6db604c7bcb08b7e496c6d6021f827405556b4fb2f9e527339fc21e6f72556df2dd67c3f09e2ab5e2e9aa2695ec76813dc7
|
data/README.md
CHANGED
@@ -11,6 +11,7 @@ A free and open-source [Jekyll](https://jekyllrb.com) theme. Based on Rohan Chan
|
|
11
11
|
* Bootstrap : [Get Bootstrap](http://getbootstrap.com/)
|
12
12
|
* Search feature : [Simple-Jekyll-Search](https://github.com/christian-fei/Simple-Jekyll-Search)
|
13
13
|
* Math Rendering : [KateX](https://github.com/Khan/KaTeX)
|
14
|
+
* Nice fonts : [Font Awesome](https://fontawesome.com/), [Source Sans Pro](https://fonts.google.com/specimen/Source+Sans+Pro), [Pacifico](https://fonts.google.com/specimen/Pacifico?selection.family=Pacifico)
|
14
15
|
* Seo Tags : [Jekyll-seo-tag](https://help.github.com/articles/search-engine-optimization-for-github-pages/)
|
15
16
|
* Syntax Highlighting: Easily customisable [Base16](https://github.com/chriskempson/base16)
|
16
17
|
* Free of rights images from [pexels](https://www.pexels.com/)
|
@@ -27,7 +28,8 @@ A free and open-source [Jekyll](https://jekyllrb.com) theme. Based on Rohan Chan
|
|
27
28
|
4. [Layout](https://github.com/Sylhare/Type-on-Strap#layout)
|
28
29
|
5. [Feature pages](https://github.com/Sylhare/Type-on-Strap#feature-pages)
|
29
30
|
6. [Template as a Gem](https://github.com/Sylhare/Type-on-Strap#Template-as-a-Gem)
|
30
|
-
7. [
|
31
|
+
7. [Advanced](https://github.com/Sylhare/Type-on-Strap#advanced)
|
32
|
+
8. [License](https://github.com/Sylhare/Type-on-Strap#license)
|
31
33
|
|
32
34
|
## Usage
|
33
35
|
|
@@ -53,7 +55,7 @@ jekyll-theme-basically-basic
|
|
53
55
|
├── assets
|
54
56
|
| ├── js # theme javascript, Katex, jquery, bootstrap, jekyll search,
|
55
57
|
| ├── css # isolated Bootstrap, font-awesome, katex and main css
|
56
|
-
| ├── fonts # Font-Awesome,
|
58
|
+
| ├── fonts # Font-Awesome, and other fonts
|
57
59
|
| └── img # Images used for the template
|
58
60
|
├── pages
|
59
61
|
| ├── 404.md # To be displayed when url is wrong
|
@@ -61,7 +63,7 @@ jekyll-theme-basically-basic
|
|
61
63
|
| ├── gallery.md # Gallery page for your photos
|
62
64
|
| ├── portfolio.md # Portfolio page for your projects
|
63
65
|
| ├── search.html # Search page
|
64
|
-
| └──
|
66
|
+
| └── tags.md # The tag page
|
65
67
|
├── _config.yml # sample configuration
|
66
68
|
└── index.html # sample home page (blog page paginated)
|
67
69
|
```
|
@@ -94,15 +96,15 @@ Please configure this before using the theme.
|
|
94
96
|
|
95
97
|
### Meta and Branding
|
96
98
|
|
97
|
-
Meta variables hold basic information about your Jekyll site which will be used throughout the site
|
99
|
+
Meta variables hold basic information about your Jekyll site which will be used throughout the site
|
100
|
+
and as meta properties for search engines, browsers, and the site's RSS feed.
|
98
101
|
|
99
102
|
Change these variables in `_config.yml`:
|
100
103
|
|
101
104
|
```yml
|
102
105
|
theme_settings:
|
103
106
|
title: My Jekyll Blog # Name of website
|
104
|
-
avatar: assets/img/
|
105
|
-
gravatar: f98....6bfc # MD5 hash of your email address
|
107
|
+
avatar: assets/img/triangle.png # Path of avatar image, to be displayed in the theme's header
|
106
108
|
description: My blog posts # Short description, primarily used by search engines
|
107
109
|
```
|
108
110
|
|
@@ -115,7 +117,7 @@ Customize your site header/footer with these variables in `_config.yml`:
|
|
115
117
|
```yml
|
116
118
|
theme_settings:
|
117
119
|
header_text: Welcome to my Jekyll blog
|
118
|
-
|
120
|
+
header_feature_image: assets/img/sample3.png
|
119
121
|
footer_text: Copyright 2017
|
120
122
|
```
|
121
123
|
|
@@ -147,11 +149,14 @@ Jekyll works with [liquid](https://shopify.github.io/liquid/) tags usually repre
|
|
147
149
|
{{ liquid.tag | filter }}
|
148
150
|
```
|
149
151
|
|
150
|
-
These are useful to render your jekyll files.
|
152
|
+
These are useful to render your jekyll files.
|
153
|
+
You can learn more about them on [shopify's doc](https://help.shopify.com/themes/liquid/basics)
|
151
154
|
|
152
155
|
### Footer's icons
|
153
156
|
|
154
|
-
Display the site's icon from [Font Awesome](https://fortawesome.github.io/Font-Awesome/) in the footer.
|
157
|
+
Display the site's icon from [Font Awesome](https://fortawesome.github.io/Font-Awesome/) in the footer.
|
158
|
+
All icon variables should be your username enclosed in quotes (e.g. "username") in `_config.yml`,
|
159
|
+
except for the following variables:
|
155
160
|
|
156
161
|
```yml
|
157
162
|
theme_settings:
|
@@ -166,7 +171,8 @@ Display the site's icon from [Font Awesome](https://fortawesome.github.io/Font-A
|
|
166
171
|
Optionally, if you have a [Disqus](https://disqus.com/) account, you can show a
|
167
172
|
comments section below each post.
|
168
173
|
|
169
|
-
To enable Disqus comments, add your [Disqus shortname](https://help.disqus.com/customer/portal/articles/466208)
|
174
|
+
To enable Disqus comments, add your [Disqus shortname](https://help.disqus.com/customer/portal/articles/466208)
|
175
|
+
to your project's `_config.yml` file:
|
170
176
|
|
171
177
|
```yml
|
172
178
|
theme_settings:
|
@@ -192,7 +198,8 @@ When KateX is set in `_config.yml`:
|
|
192
198
|
katex: true # to Enable it
|
193
199
|
```
|
194
200
|
|
195
|
-
You can then wrap math expressions with `$$` signs in your posts and make sure you have set the `katex` variable
|
201
|
+
You can then wrap math expressions with `$$` signs in your posts and make sure you have set the `katex` variable
|
202
|
+
in `_config.yml` to `true` for math typesetting.
|
196
203
|
|
197
204
|
For inline math typesetting, type your math expression on the *same line* as your content. For example:
|
198
205
|
|
@@ -210,7 +217,9 @@ $$
|
|
210
217
|
|
211
218
|
### Post excerpt
|
212
219
|
|
213
|
-
The [excerpt](https://jekyllrb.com/docs/posts/#post-excerpts) are the first lines of an article that is display on the blog page.
|
220
|
+
The [excerpt](https://jekyllrb.com/docs/posts/#post-excerpts) are the first lines of an article that is display on the blog page.
|
221
|
+
The length of the excerpt has a default of around `250` characters and can be manually set in the post using:
|
222
|
+
|
214
223
|
```yml
|
215
224
|
---
|
216
225
|
layout: post
|
@@ -226,7 +235,8 @@ some text in the excerpt
|
|
226
235
|
The html is stripped out of the excerpt so it only display text.
|
227
236
|
|
228
237
|
## Layout
|
229
|
-
Please refer to the [Jekyll docs for writing posts](https://jekyllrb.com/docs/posts/).
|
238
|
+
Please refer to the [Jekyll docs for writing posts](https://jekyllrb.com/docs/posts/).
|
239
|
+
Non-standard features are documented below.
|
230
240
|
|
231
241
|
### Layout: Post
|
232
242
|
|
@@ -239,14 +249,20 @@ title: Hello World # Title of the page
|
|
239
249
|
hide_title: true # Hide the title when displaying the post, but shown in lists of posts
|
240
250
|
feature-img: "assets/img/sample.png" # Add a feature-image to the post
|
241
251
|
thumbnail: "assets/img/thumbnail/sample-th.png" # Add a thumbnail image on blog view
|
252
|
+
color: rgb(80,140,22) # Add the specified color as feature image, and change link colors in post
|
242
253
|
bootstrap: true # Add bootstrap to the page
|
243
254
|
tags: [sample, markdown, html]
|
244
255
|
---
|
245
256
|
```
|
246
257
|
|
247
|
-
With `thumbnail`, you can add a smaller image than the `feature-img`.
|
258
|
+
With `thumbnail`, you can add a smaller image than the `feature-img`.
|
259
|
+
If you don't want/have a thumbnail you can still use the same image as the feature one.
|
260
|
+
|
261
|
+
The background used when `color` is set comes from `lineart.png` from [xukimseven](https://github.com/xukimseven)
|
262
|
+
you can edit it in the config file (`theme_settings > color_image`). If you want another one, put it in `/assets/img` as well.
|
248
263
|
|
249
|
-
|
264
|
+
The **bootstrap** is not mandatory and is only useful if you want to add bootstrapped content in your page.
|
265
|
+
It will respect the page and theme layout, mind the padding on the sides.
|
250
266
|
|
251
267
|
### Layout: Page
|
252
268
|
|
@@ -260,11 +276,13 @@ subtitle: "This is a subtitle"
|
|
260
276
|
feature-img: "assets/img/sample.png"
|
261
277
|
permalink: /about.html # Set a permalink your your page
|
262
278
|
hide: true # Prevent the page title to appear in the navbar
|
279
|
+
icon: "fa-search" # Will Display only the fontawesome icon (here: fa-search) and not the title
|
263
280
|
tags: [sample, markdown, html]
|
264
281
|
---
|
265
282
|
```
|
266
283
|
|
267
|
-
The hide only hides your page from the navigation bar, it is however still generated and can be access through its link.
|
284
|
+
The hide only hides your page from the navigation bar, it is however still generated and can be access through its link.
|
285
|
+
Use the `_draft` folder to keep files from being generated on your site.
|
268
286
|
|
269
287
|
### Layout: Default
|
270
288
|
|
@@ -272,7 +290,8 @@ This layout includes the head, navigation bar and footer around your content.
|
|
272
290
|
|
273
291
|
## Feature pages
|
274
292
|
|
275
|
-
All feature pages besides the "home" one are stored in the `page` folder,
|
293
|
+
All feature pages besides the "home" one are stored in the `page` folder,
|
294
|
+
they will appear in the navigation bar unless you set `Hide: true` in the front matter.
|
276
295
|
|
277
296
|
Here are the documentation for the other feature pages that can be added through `_config.yml`.
|
278
297
|
|
@@ -281,7 +300,8 @@ Here are the documentation for the other feature pages that can be added through
|
|
281
300
|
This page is the used as the home page of the template (in the `index.html`). It displays the list of article in `_posts`.
|
282
301
|
You can use this layout in another page (adding a title to it will make it appear in the navigation bar).
|
283
302
|
|
284
|
-
The recommended width and height for the home picture is width:`2484px;` and height:`1280px`
|
303
|
+
The recommended width and height for the home picture is width:`2484px;` and height:`1280px`
|
304
|
+
which are the dimension of the actual picture for it to be rolling down as you scroll the page.
|
285
305
|
|
286
306
|
### Portfolio
|
287
307
|
|
@@ -297,11 +317,30 @@ title : Portfolio
|
|
297
317
|
{% include portfolio.html %}
|
298
318
|
```
|
299
319
|
|
300
|
-
|
320
|
+
#### Portofolio posts
|
321
|
+
|
322
|
+
You can format the portfolio posts in the `_portfolio` folder using the `post layout`. Here are little explaination on some of the possible feature you can use and what they will do.
|
301
323
|
|
302
|
-
|
324
|
+
If you decide to use a date, please be sure to use one that can be parsed such as `yyyy-mm-dd`. You can see more format example on the demo posts that are available for the theme:
|
303
325
|
|
326
|
+
```yml
|
327
|
+
---
|
328
|
+
layout: post
|
329
|
+
title: Circus # Title of the portfolio post
|
330
|
+
feature-img: "assets/img/portfolio/cake.png" # Will display the image in the post
|
331
|
+
img: "assets/img/portfolio/cake.png" # Will display the image in the portfolio page
|
332
|
+
date: 2019-07-25 # Not mandatory, however needs to be in date format to display the date
|
333
|
+
---
|
304
334
|
```
|
335
|
+
|
336
|
+
### Gallery
|
337
|
+
|
338
|
+
You can create a gallery using [Masonry JS](https://masonry.desandro.com/) which will placing the pictures in optimal position
|
339
|
+
based on available vertical space.
|
340
|
+
You need to specify the `gallery_path` which will be used to find the pictures to render.
|
341
|
+
It will take all of the picture under that directory. Then use the `include` to add it in your page.
|
342
|
+
|
343
|
+
```yml
|
305
344
|
---
|
306
345
|
layout: page
|
307
346
|
title: Gallery
|
@@ -314,22 +353,25 @@ gallery: "assets/img/pexels"
|
|
314
353
|
|
315
354
|
### Search
|
316
355
|
|
317
|
-
The search feature is based on [Simple-Jekyll-search](https://github.com/christian-fei/Simple-Jekyll-Search)
|
356
|
+
The search feature is based on [Simple-Jekyll-search](https://github.com/christian-fei/Simple-Jekyll-Search)
|
357
|
+
there is a `search.json` file that will create a list of all of the site posts, pages and portfolios.
|
318
358
|
|
319
359
|
Then there's a `search.js` displaying the formatted results entered in the `search.html` page.
|
320
360
|
|
361
|
+
The search page can be hidden with the `hide` option. You can remove the icon by removing `icon`:
|
321
362
|
|
322
|
-
The search page can be enable/disable in the navigation bar through the `_config.yml` via:
|
323
363
|
```yml
|
324
|
-
|
325
|
-
|
326
|
-
|
327
|
-
|
364
|
+
---
|
365
|
+
layout: search
|
366
|
+
title: Search
|
367
|
+
icon: "search"
|
368
|
+
---
|
328
369
|
```
|
329
370
|
|
330
371
|
### Tags
|
331
372
|
|
332
|
-
Tags should be placed between `[]` in your post metadata. Separate each tag with a comma.
|
373
|
+
Tags should be placed between `[]` in your post metadata. Separate each tag with a comma.
|
374
|
+
Tags are recommended for posts and portfolio items.
|
333
375
|
|
334
376
|
For example:
|
335
377
|
|
@@ -344,18 +386,12 @@ tags: [sample, markdown, html]
|
|
344
386
|
> Tags are case sensitive `Tag_nAme` ≠ `tag_name`
|
345
387
|
|
346
388
|
All the tags will be listed in `tags.html` with a link toward the pages or posts.
|
347
|
-
The
|
348
|
-
|
349
|
-
```yml
|
350
|
-
special_page:
|
351
|
-
tags:
|
352
|
-
icon: "tags"
|
353
|
-
enabled: true
|
354
|
-
```
|
389
|
+
The Tag page can be hidden with the `hide` option. You can remove the icon by removing `icon` (like for the search page).
|
355
390
|
|
356
391
|
## Template as a Gem
|
357
392
|
|
358
|
-
You can use Type-on-strap as a [gem](https://rubygems.org/gems/type-on-strap).
|
393
|
+
You can use Type-on-strap as a [gem](https://rubygems.org/gems/type-on-strap).
|
394
|
+
Checkout an example in the [gem-demo branch](https://github.com/Sylhare/Type-on-Strap/tree/gem-demo).
|
359
395
|
To make the feature pages available in from the gem I created them as layouts that can be invoked in the pages folder.
|
360
396
|
|
361
397
|
So if you're using the template as a theme, Make sure you have:
|
@@ -366,6 +402,31 @@ So if you're using the template as a theme, Make sure you have:
|
|
366
402
|
|
367
403
|
Now you can use any theme gem with github pages : [29/11/2017 Github Pages Broadcast](https://github.com/blog/2464-use-any-theme-with-github-pages)
|
368
404
|
|
405
|
+
## Advanced
|
406
|
+
|
407
|
+
### Minimizing and optimizing: css, js and images
|
408
|
+
|
409
|
+
Before you need to have `node` and `npm` installed:
|
410
|
+
- Windows: https://nodejs.org/
|
411
|
+
- Ubuntu/Debian: `apt-get install nodejs npm libgl1 libxi6`
|
412
|
+
- Fedora (dnf) / RHEL/CentOS (yum): `dnf install node npm libglvnd-glx libXi`
|
413
|
+
|
414
|
+
Then you need to install [`gulp-cli`](https://gulpjs.com/) and its dependencies:
|
415
|
+
```shell
|
416
|
+
cd assets/
|
417
|
+
sudo npm install gulp-cli -g
|
418
|
+
npm install
|
419
|
+
```
|
420
|
+
|
421
|
+
**Now, whenever you want to minify and optimize, run:**
|
422
|
+
```shell
|
423
|
+
cd assets/
|
424
|
+
gulp default
|
425
|
+
# tip: run a git status to see the changes
|
426
|
+
git status
|
427
|
+
```
|
428
|
+
|
369
429
|
## License
|
370
430
|
|
431
|
+
There are some fonts and component on this theme going under the MIT licence as well in this theme.
|
371
432
|
[The MIT License (MIT)](https://raw.githubusercontent.com/Sylhare/Type-on-Strap/master/LICENSE)
|
data/_data/language.yml
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
# Localization strings
|
2
|
+
str_follow_on: "Follow on"
|
3
|
+
str_rss_follow: "Follow RSS feed"
|
4
|
+
str_share_on: "Share on"
|
5
|
+
str_add_to: "Add to"
|
6
|
+
str_email: "Email"
|
7
|
+
str_tweet: "Tweet"
|
8
|
+
str_pin_it: "Pin it"
|
9
|
+
str_next_post: "Next post"
|
10
|
+
str_previous_post: "Previous post"
|
11
|
+
str_next_page: "Next"
|
12
|
+
str_previous_page: "Prev"
|
13
|
+
str_javascript_required_disqus: "Please enable JavaScript to view comments."
|
data/_includes/blog.html
CHANGED
@@ -3,23 +3,29 @@
|
|
3
3
|
<div class="post-teaser">
|
4
4
|
{% if post.thumbnail %}
|
5
5
|
<div class="post-img">
|
6
|
-
<
|
6
|
+
<a aria-label="{{ post.title }}" href="{{ post.url | relative_url }}">
|
7
|
+
<img alt="{{ post.title }}" src="{{ post.thumbnail | relative_url }}">
|
8
|
+
</a>
|
7
9
|
</div>
|
8
10
|
{% endif %}
|
9
11
|
<span>
|
10
12
|
<header>
|
11
13
|
<h1>
|
12
|
-
<a
|
14
|
+
<a aria-label="{{ post.title }}" class="post-link" href="{{ post.url | relative_url }}">
|
13
15
|
{{ post.title }}
|
14
16
|
</a>
|
15
17
|
</h1>
|
16
|
-
|
17
|
-
{{ post.date | date: "%B %-d, %Y" }}
|
18
|
-
</p>
|
18
|
+
{% include post_info.html author=post.author date=post.date %}
|
19
19
|
</header>
|
20
|
-
|
21
|
-
|
22
|
-
|
20
|
+
{% if site.theme_settings.excerpt %}
|
21
|
+
<div class="excerpt">
|
22
|
+
{% if site.theme_settings.excerpt == "truncate" %}
|
23
|
+
{{ post.content | strip_html | truncate: '250' | escape }}
|
24
|
+
{% else %}
|
25
|
+
{{ post.excerpt | strip_html | escape }}
|
26
|
+
{% endif %}
|
27
|
+
</div>
|
28
|
+
{% endif %}
|
23
29
|
</span>
|
24
30
|
</div>
|
25
31
|
{% endfor %}
|
data/_includes/blog_nav.html
CHANGED
@@ -4,15 +4,16 @@
|
|
4
4
|
|
5
5
|
{% if paginator.previous_page and paginator.previous_page != 1%}
|
6
6
|
<!-- << -->
|
7
|
-
<a
|
8
|
-
<i class="fa fa-angle-double-left"></i>
|
7
|
+
<a aria-label="{{ site.data.language.str_previous_page }}" href="{{ '/' | relative_url }}" class="button">
|
8
|
+
<span><i class="fa fa-angle-double-left"></i></span>
|
9
9
|
</a>
|
10
10
|
{% endif %}
|
11
11
|
|
12
12
|
<!-- < previous -->
|
13
|
-
<a
|
14
|
-
|
15
|
-
|
13
|
+
<a aria-label="{{ site.data.language.str_previous_page }}" href="{{ paginator.previous_page_path | relative_url }}"
|
14
|
+
{% unless paginator.previous_page %}style="visibility:hidden"{% endunless %} class="button">
|
15
|
+
<span><i class="fa fa-chevron-left"></i></span>
|
16
|
+
{{ site.data.language.str_previous_page }}
|
16
17
|
</a>
|
17
18
|
</div>
|
18
19
|
|
@@ -23,15 +24,16 @@
|
|
23
24
|
<div class="next">
|
24
25
|
|
25
26
|
<!-- next > -->
|
26
|
-
<a
|
27
|
-
|
28
|
-
|
27
|
+
<a aria-label="{{ site.data.language.str_next_page }}" href="{{ paginator.next_page_path | relative_url }}"
|
28
|
+
{% unless paginator.next_page %}style="visibility:hidden"{% endunless %} class="button">
|
29
|
+
{{ site.data.language.str_next_page }}
|
30
|
+
<span><i class="fa fa-chevron-right"></i></span>
|
29
31
|
</a>
|
30
32
|
|
31
33
|
{% if paginator.next_page and paginator.next_page != paginator.total_pages %}
|
32
34
|
<!-- >> -->
|
33
|
-
<a href="{{ site.paginate_path | relative_url | replace: ':num', paginator.total_pages }}"
|
34
|
-
<i class="fa fa-angle-double-right"></i>
|
35
|
+
<a aria-label="{{ site.data.language.str_next_page }}" href="{{ site.paginate_path | relative_url | replace: ':num', paginator.total_pages }}" class="button">
|
36
|
+
<span><i class="fa fa-angle-double-right"></i></span>
|
35
37
|
</a>
|
36
38
|
{% endif %}
|
37
39
|
|
data/_includes/disqus.html
CHANGED
@@ -7,4 +7,4 @@
|
|
7
7
|
(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
|
8
8
|
})();
|
9
9
|
</script>
|
10
|
-
<noscript>{{ site.
|
10
|
+
<noscript>{{ site.data.language.str_javascript_required_disqus }}</noscript>
|
data/_includes/head.html
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
<head>
|
2
2
|
<meta charset="utf-8">
|
3
3
|
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
|
4
|
-
|
4
|
+
|
5
5
|
<!-- Main JS (navbar.js, katex_init.js and masonry_init.js)-->
|
6
6
|
<script defer=true src="{{ '/assets/js/main.min.js' | relative_url }}"></script>
|
7
7
|
|
@@ -15,11 +15,7 @@
|
|
15
15
|
<link rel="canonical" href="{{ page.url | replace:'index.html','' | absolute_url }}">
|
16
16
|
|
17
17
|
<!-- RSS -->
|
18
|
-
<link rel="alternate" type="application/atom+xml" title="{{ site.
|
19
|
-
|
20
|
-
<!-- Font Awesome -->
|
21
|
-
<!-- <link href="//maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet"> -->
|
22
|
-
<link rel="stylesheet" type="text/css" href="{{ '/assets/css/vendor/font-awesome.min.css' | relative_url }}">
|
18
|
+
<link rel="alternate" type="application/atom+xml" title="{{ site.title }}" href="{{ 'feed.xml' | absolute_url }}"/>
|
23
19
|
|
24
20
|
{% if page.bootstrap %}
|
25
21
|
<!-- Bootstrap-4.1.3 isolation CSS -->
|
@@ -33,47 +29,37 @@
|
|
33
29
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.3/umd/popper.min.js" integrity="sha384-ZMP7rVo3mIykV+2+9J3UJ46jBk0WLaUAdn689aCwoqbBJiSnjAK/l8WvCWPIPm49" crossorigin="anonymous"></script>
|
34
30
|
{% endif %}
|
35
31
|
|
36
|
-
<!-- Google Fonts -->
|
37
|
-
{% if site.theme_settings.google_fonts %}
|
38
|
-
<link href="//fonts.googleapis.com/css?family={{ site.theme_settings.google_fonts }}" rel="stylesheet" type="text/css">
|
39
|
-
{% else %}
|
40
|
-
<link rel="stylesheet" href="{{ '/assets/css/vendor/google_fonts.min.css' | relative_url }}">
|
41
|
-
{% endif %}
|
42
|
-
|
43
32
|
<!-- KaTeX 0.8.3 -->
|
44
33
|
<!-- if you have any issue check https://github.com/KaTeX/KaTeX -->
|
45
34
|
{% if site.theme_settings.katex %}
|
46
|
-
<
|
47
|
-
<script src="{{ '/assets/js/vendor/katex.min.js' | relative_url }}">
|
48
|
-
</script>
|
35
|
+
<script src="{{ '/assets/js/vendor/katex.min.js' | relative_url }}"></script>
|
49
36
|
{% endif %}
|
50
37
|
|
51
38
|
<!-- Google Analytics -->
|
52
39
|
{% if site.theme_settings.google_analytics %}
|
40
|
+
<!-- Global site tag (gtag.js) -->
|
41
|
+
<script async src="https://www.googletagmanager.com/gtag/js?id={{ site.theme_settings.google_analytics }}"></script>
|
53
42
|
<script>
|
54
|
-
|
55
|
-
|
56
|
-
|
57
|
-
|
58
|
-
}, i[r].l = 1 * new Date();
|
59
|
-
a = s.createElement(o),
|
60
|
-
m = s.getElementsByTagName(o)[0];
|
61
|
-
a.async = 1;
|
62
|
-
a.src = g;
|
63
|
-
m.parentNode.insertBefore(a, m)
|
64
|
-
})(window, document, 'script', '//www.google-analytics.com/analytics.js', 'ga');
|
65
|
-
|
66
|
-
ga('create', '{{ site.theme_settings.google_analytics }}', 'auto');
|
67
|
-
ga('send', 'pageview');
|
68
|
-
|
43
|
+
window.dataLayer = window.dataLayer || [];
|
44
|
+
function gtag(){dataLayer.push(arguments);}
|
45
|
+
gtag('js', new Date());
|
46
|
+
gtag('config', '{{ site.theme_settings.google_analytics }}');
|
69
47
|
</script>
|
70
|
-
{% endif %}
|
71
48
|
|
49
|
+
<!-- Page analysis (analytics.js) -->
|
50
|
+
<script async src='https://www.google-analytics.com/analytics.js'></script>
|
51
|
+
<script>
|
52
|
+
window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date;
|
53
|
+
ga('create', '{{ site.theme_settings.google_analytics }}', 'auto');
|
54
|
+
ga('send', 'pageview');
|
55
|
+
</script>
|
56
|
+
{% endif %} <!-- End Google Analytics -->
|
57
|
+
|
72
58
|
<!-- seo tags -->
|
73
59
|
{% seo %}
|
74
60
|
<!-- Manual seo tags -->
|
75
61
|
<!--
|
76
|
-
<title>{% if page.title %}{{ page.title }} |{% endif %} {{ site.
|
62
|
+
<title>{% if page.title %}{{ page.title }} |{% endif %} {{ site.title }}</title>
|
77
63
|
<meta name="description" content="{% if page.excerpt %}{{ page.excerpt | strip_html | strip_newlines | truncate: 160 }}{% else %}{{ site.theme_settings.description }}{% endif %}">
|
78
64
|
-->
|
79
65
|
</head>
|