type-on-strap 2.3.1 → 2.3.7
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/LICENSE +1 -1
- data/README.md +87 -41
- data/_data/icons_builder.yml +82 -0
- data/_data/language.yml +4 -0
- data/_includes/{blog.html → blog/blog.html} +5 -2
- data/_includes/{blog_nav.html → blog/blog_nav.html} +4 -4
- data/_includes/blog/post_info.html +15 -0
- data/_includes/{post_nav.html → blog/post_nav.html} +0 -0
- data/_includes/{footer.html → default/footer.html} +1 -1
- data/_includes/{head.html → default/head.html} +24 -12
- data/_includes/{navbar.html → default/navbar.html} +7 -2
- data/_includes/default/tags_list.html +21 -0
- data/_includes/gallery.html +2 -3
- data/_includes/portfolio.html +1 -2
- data/_includes/social/cusdis.html +13 -0
- data/_includes/{disqus.html → social/disqus.html} +1 -1
- data/_includes/social/icons.html +34 -0
- data/_includes/social/share_buttons.html +92 -0
- data/_includes/social/utterances.html +8 -0
- data/_layouts/{custom.html → custom.md} +15 -10
- data/_layouts/default.html +4 -5
- data/_layouts/home.html +1 -1
- data/_layouts/page.html +1 -1
- data/_layouts/post.html +28 -15
- data/_layouts/search.html +1 -1
- data/_layouts/tags.html +61 -68
- data/_sass/base/_global.scss +11 -11
- data/_sass/base/_highlight.scss +77 -72
- data/_sass/base/_utility.scss +13 -7
- data/_sass/base/_variables.scss +112 -74
- data/_sass/external/_font-awesome.scss +17 -15
- data/_sass/external/_katex.scss +1103 -899
- data/_sass/external/font-awesome/_animated.scss +6 -20
- data/_sass/external/font-awesome/_bordered-pulled.scss +6 -11
- data/_sass/external/font-awesome/_brands.scss +23 -0
- data/_sass/external/font-awesome/_core.scss +15 -6
- data/_sass/external/font-awesome/_fixed-width.scss +1 -1
- data/_sass/external/font-awesome/_icons.scss +1460 -787
- data/_sass/external/font-awesome/_larger.scss +16 -6
- data/_sass/external/font-awesome/_list.scss +7 -8
- data/_sass/external/font-awesome/_mixins.scss +16 -20
- data/_sass/external/font-awesome/_regular.scss +23 -0
- data/_sass/external/font-awesome/_rotated-flipped.scss +10 -6
- data/_sass/external/font-awesome/_screen-reader.scss +2 -2
- data/_sass/external/font-awesome/_shims.scss +2066 -0
- data/_sass/external/font-awesome/_solid.scss +24 -0
- data/_sass/external/font-awesome/_stacked.scss +19 -8
- data/_sass/external/font-awesome/_variables.scss +1474 -795
- data/_sass/external/font-awesome/v4-shims.scss +6 -0
- data/_sass/includes/_footer.scss +13 -2
- data/_sass/includes/_mermaid.scss +13 -0
- data/_sass/includes/_navbar.scss +7 -6
- data/_sass/includes/_share_buttons.scss +12 -2
- data/_sass/layouts/_blog.scss +14 -17
- data/_sass/layouts/_page.scss +3 -2
- data/_sass/layouts/_posts.scss +27 -7
- data/_sass/layouts/_search.scss +11 -8
- data/_sass/layouts/_tags.scss +21 -8
- data/_sass/type-on-strap.scss +5 -4
- data/assets/css/vendor/bootstrap-iso.css +0 -30
- data/assets/css/vendor/bootstrap-iso.min.css +1 -1
- data/assets/css/vendor/bootstrap.css +0 -30
- data/assets/fonts/font-awesome/fa-brands-400.eot +0 -0
- data/assets/fonts/font-awesome/fa-brands-400.svg +3717 -0
- data/assets/fonts/font-awesome/fa-brands-400.ttf +0 -0
- data/assets/fonts/font-awesome/fa-brands-400.woff +0 -0
- data/assets/fonts/font-awesome/fa-brands-400.woff2 +0 -0
- data/assets/fonts/font-awesome/fa-regular-400.eot +0 -0
- data/assets/fonts/font-awesome/fa-regular-400.svg +801 -0
- data/assets/fonts/font-awesome/fa-regular-400.ttf +0 -0
- data/assets/fonts/font-awesome/fa-regular-400.woff +0 -0
- data/assets/fonts/font-awesome/fa-regular-400.woff2 +0 -0
- data/assets/fonts/font-awesome/fa-solid-900.eot +0 -0
- data/assets/fonts/font-awesome/fa-solid-900.svg +5028 -0
- data/assets/fonts/font-awesome/fa-solid-900.ttf +0 -0
- data/assets/fonts/font-awesome/fa-solid-900.woff +0 -0
- data/assets/fonts/font-awesome/fa-solid-900.woff2 +0 -0
- data/assets/fonts/katex/KaTeX_AMS-Regular.ttf +0 -0
- data/assets/fonts/katex/KaTeX_AMS-Regular.woff +0 -0
- data/assets/fonts/katex/KaTeX_AMS-Regular.woff2 +0 -0
- data/assets/fonts/katex/KaTeX_Caligraphic-Bold.ttf +0 -0
- data/assets/fonts/katex/KaTeX_Caligraphic-Bold.woff +0 -0
- data/assets/fonts/katex/KaTeX_Caligraphic-Bold.woff2 +0 -0
- data/assets/fonts/katex/KaTeX_Caligraphic-Regular.ttf +0 -0
- data/assets/fonts/katex/KaTeX_Caligraphic-Regular.woff +0 -0
- data/assets/fonts/katex/KaTeX_Caligraphic-Regular.woff2 +0 -0
- data/assets/fonts/katex/KaTeX_Fraktur-Bold.ttf +0 -0
- data/assets/fonts/katex/KaTeX_Fraktur-Bold.woff +0 -0
- data/assets/fonts/katex/KaTeX_Fraktur-Bold.woff2 +0 -0
- data/assets/fonts/katex/KaTeX_Fraktur-Regular.ttf +0 -0
- data/assets/fonts/katex/KaTeX_Fraktur-Regular.woff +0 -0
- data/assets/fonts/katex/KaTeX_Fraktur-Regular.woff2 +0 -0
- data/assets/fonts/katex/KaTeX_Main-Bold.ttf +0 -0
- data/assets/fonts/katex/KaTeX_Main-Bold.woff +0 -0
- data/assets/fonts/katex/KaTeX_Main-Bold.woff2 +0 -0
- data/assets/fonts/katex/KaTeX_Main-BoldItalic.ttf +0 -0
- data/assets/fonts/katex/KaTeX_Main-BoldItalic.woff +0 -0
- data/assets/fonts/katex/KaTeX_Main-BoldItalic.woff2 +0 -0
- data/assets/fonts/katex/KaTeX_Main-Italic.ttf +0 -0
- data/assets/fonts/katex/KaTeX_Main-Italic.woff +0 -0
- data/assets/fonts/katex/KaTeX_Main-Italic.woff2 +0 -0
- data/assets/fonts/katex/KaTeX_Main-Regular.ttf +0 -0
- data/assets/fonts/katex/KaTeX_Main-Regular.woff +0 -0
- data/assets/fonts/katex/KaTeX_Main-Regular.woff2 +0 -0
- data/assets/fonts/katex/KaTeX_Math-BoldItalic.ttf +0 -0
- data/assets/fonts/katex/KaTeX_Math-BoldItalic.woff +0 -0
- data/assets/fonts/katex/KaTeX_Math-BoldItalic.woff2 +0 -0
- data/assets/fonts/katex/KaTeX_Math-Italic.ttf +0 -0
- data/assets/fonts/katex/KaTeX_Math-Italic.woff +0 -0
- data/assets/fonts/katex/KaTeX_Math-Italic.woff2 +0 -0
- data/assets/fonts/katex/KaTeX_SansSerif-Bold.ttf +0 -0
- data/assets/fonts/katex/KaTeX_SansSerif-Bold.woff +0 -0
- data/assets/fonts/katex/KaTeX_SansSerif-Bold.woff2 +0 -0
- data/assets/fonts/katex/KaTeX_SansSerif-Italic.ttf +0 -0
- data/assets/fonts/katex/KaTeX_SansSerif-Italic.woff +0 -0
- data/assets/fonts/katex/KaTeX_SansSerif-Italic.woff2 +0 -0
- data/assets/fonts/katex/KaTeX_SansSerif-Regular.ttf +0 -0
- data/assets/fonts/katex/KaTeX_SansSerif-Regular.woff +0 -0
- data/assets/fonts/katex/KaTeX_SansSerif-Regular.woff2 +0 -0
- data/assets/fonts/katex/KaTeX_Script-Regular.ttf +0 -0
- data/assets/fonts/katex/KaTeX_Script-Regular.woff +0 -0
- data/assets/fonts/katex/KaTeX_Script-Regular.woff2 +0 -0
- data/assets/fonts/katex/KaTeX_Size1-Regular.ttf +0 -0
- data/assets/fonts/katex/KaTeX_Size1-Regular.woff +0 -0
- data/assets/fonts/katex/KaTeX_Size1-Regular.woff2 +0 -0
- data/assets/fonts/katex/KaTeX_Size2-Regular.ttf +0 -0
- data/assets/fonts/katex/KaTeX_Size2-Regular.woff +0 -0
- data/assets/fonts/katex/KaTeX_Size2-Regular.woff2 +0 -0
- data/assets/fonts/katex/KaTeX_Size3-Regular.ttf +0 -0
- data/assets/fonts/katex/KaTeX_Size3-Regular.woff +0 -0
- data/assets/fonts/katex/KaTeX_Size3-Regular.woff2 +0 -0
- data/assets/fonts/katex/KaTeX_Size4-Regular.ttf +0 -0
- data/assets/fonts/katex/KaTeX_Size4-Regular.woff +0 -0
- data/assets/fonts/katex/KaTeX_Size4-Regular.woff2 +0 -0
- data/assets/fonts/katex/KaTeX_Typewriter-Regular.ttf +0 -0
- data/assets/fonts/katex/KaTeX_Typewriter-Regular.woff +0 -0
- data/assets/fonts/katex/KaTeX_Typewriter-Regular.woff2 +0 -0
- data/assets/js/main.min.js +1 -1
- data/assets/js/partials/dark-mode.js +43 -0
- data/assets/js/vendor/auto-render.min.js +1 -1
- data/assets/js/vendor/katex.min.js +1 -1
- data/assets/js/vendor/mermaid.min.js +29 -29
- data/assets/js/vendor/simple-jekyll-search.min.js +3 -3
- metadata +39 -23
- data/_includes/icons.html +0 -267
- data/_includes/post_info.html +0 -13
- data/_includes/share_buttons.html +0 -81
- data/_includes/tags_list.html +0 -23
- data/_sass/external/font-awesome/_path.scss +0 -16
- data/_sass/external/font-awesome/font-awesome.scss +0 -17
- data/assets/fonts/fontawesome/FontAwesome.otf +0 -0
- data/assets/fonts/fontawesome/fontawesome-webfont.eot +0 -0
- data/assets/fonts/fontawesome/fontawesome-webfont.svg +0 -2671
- data/assets/fonts/fontawesome/fontawesome-webfont.ttf +0 -0
- data/assets/fonts/fontawesome/fontawesome-webfont.woff +0 -0
- data/assets/fonts/fontawesome/fontawesome-webfont.woff2 +0 -0
- data/assets/js/vendor/mermaid.min.js.map +0 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 0e912396979eb944a0691e338ab364b3253e471bf21aa1b46d4896906805063f
|
4
|
+
data.tar.gz: 5ef7f480ea958f2742f1babf7c7f9a3c1e7e04fa99ece8ab40a29827b9c59aaa
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6fe7611948fabbbc956cad3f1cb166e265a9404c1c04156d3efab13a0b3151b5d5cb6a472127df0bf282a5f0176ef8bba9d3e2ef1e45029330703390ac5d543c
|
7
|
+
data.tar.gz: b0fcc4324bd86a5e9b31ddd874206fcbd04d1d44a2e6b10d744e185556d9e33267d06f1b3ec1317e7f21a60dc9cdc728e851d28ab547f56a735937050a7749ee
|
data/LICENSE
CHANGED
data/README.md
CHANGED
@@ -4,39 +4,31 @@
|
|
4
4
|
[![Gem Version](https://badge.fury.io/rb/type-on-strap.svg)](https://badge.fury.io/rb/type-on-strap)
|
5
5
|
[![Docker Pulls](https://img.shields.io/docker/pulls/sylhare/type-on-strap)](https://hub.docker.com/r/sylhare/type-on-strap)
|
6
6
|
|
7
|
-
[![Default Type on Strap blog](https://github.com/Sylhare/Type-on-Strap/blob/master/screenshot.png?raw=true)](https://sylhare.github.io/Type-on-Strap/)
|
7
|
+
[![Default Type on Strap blog](https://github.com/Sylhare/Type-on-Strap/blob/master/assets/img/screenshot.png?raw=true)](https://sylhare.github.io/Type-on-Strap/)
|
8
8
|
|
9
|
-
A free and open-source [Jekyll](https://jekyllrb.com) theme. Based on Rohan Chandra [type-theme](https://github.com/rohanchandra/type-theme) packed with extra features and easily
|
9
|
+
A free and open-source [Jekyll](https://jekyllrb.com) theme. Based on Rohan Chandra [type-theme](https://github.com/rohanchandra/type-theme) packed with extra features and easily customizable:
|
10
10
|
|
11
11
|
* Responsive design on all devices (🖥, 💻, 📱, ...)
|
12
12
|
* Portfolio 🗂, Gallery 🖼 pages for your projects
|
13
|
+
* Multi comments 💬 options
|
13
14
|
* Tags compatibility 🏷
|
14
|
-
* Handle
|
15
|
+
* Handle _Bootstrap_'ed pages: [Get Bootstrap](http://getbootstrap.com/)
|
15
16
|
* 🔎 Search feature: [Simple-Jekyll-Search](https://github.com/christian-fei/Simple-Jekyll-Search)
|
16
17
|
* Math Rendering : [KateX](https://github.com/Khan/KaTeX)
|
17
18
|
* Diagram Rendering: [Mermaid-js](https://github.com/mermaid-js/mermaid)
|
18
19
|
* 🖋 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)
|
19
20
|
* Seo Tags: [Jekyll-seo-tag](https://github.com/jekyll/jekyll-seo-tag)
|
20
21
|
* 🛠 Syntax Highlighting: Easily customisable [Base16](https://github.com/chriskempson/base16)
|
22
|
+
* 💡 Light and dark theme supported
|
21
23
|
* Find free of rights images on [pexels](https://www.pexels.com/)
|
22
24
|
|
23
25
|
> [Demo Site](https://sylhare.github.io/Type-on-Strap/)
|
24
26
|
|
25
|
-
## Table of Contents
|
26
|
-
|
27
|
-
- [Usage](#usage)
|
28
|
-
- [Structure](#structure)
|
29
|
-
- [Configure Type on Strap](#configure-type-on-strap)
|
30
|
-
- [Other Layouts](#other-layouts)
|
31
|
-
- [Feature pages](#feature-pages)
|
32
|
-
- [Advanced](#advanced)
|
33
|
-
- [License](#license)
|
34
|
-
|
35
27
|
## Usage
|
36
28
|
|
37
29
|
### As a ruby gem 💎
|
38
30
|
|
39
|
-
Check out this tutorial: [Use as Ruby Gem](
|
31
|
+
Check out this tutorial: [Use as Ruby Gem](#use-as-ruby-gem-)
|
40
32
|
|
41
33
|
### As a github page 📋
|
42
34
|
|
@@ -44,7 +36,7 @@ Check out this tutorial: [Use as Ruby Gem](https://github.com/Sylhare/Type-on-St
|
|
44
36
|
2. Install [Jekyll](https://jekyllrb.com/docs/installation/): `gem install jekyll`, check [#1](https://github.com/Sylhare/Type-on-Strap/issues/1) if you have a problem.
|
45
37
|
3. Install the theme's dependencies: `bundle install`
|
46
38
|
4. Customize the theme
|
47
|
-
-
|
39
|
+
- GitHub Page: [update `_config.yml`](#site-configuration)
|
48
40
|
5. Run the Jekyll server: `bundle exec jekyll serve`
|
49
41
|
|
50
42
|
## Structure
|
@@ -74,7 +66,8 @@ Type-on-Strap
|
|
74
66
|
├── _data.yml
|
75
67
|
| ├── authors.yml # Update the post authors configurations
|
76
68
|
| ├── language.yml # Localization configuration
|
77
|
-
|
|
69
|
+
| ├── social.yml # Social configurations to share posts (RSS, shares, ...)
|
70
|
+
| └── icons.yml # Footer icons (Twitter, Github, Stackoverflow, ...)
|
78
71
|
└── index.html # sample home page (blog page paginated)
|
79
72
|
```
|
80
73
|
|
@@ -84,10 +77,9 @@ Open `_config.yml` in a text editor to change most of the blog's settings.
|
|
84
77
|
|
85
78
|
If a variable in this document is marked as "optional", disable the feature by removing all text from the variable.
|
86
79
|
|
87
|
-
|
88
80
|
### Site configuration
|
89
81
|
|
90
|
-
Configure Jekyll as your own blog or with a "baseurl" in
|
82
|
+
Configure Jekyll as your own blog or with a "baseurl" in `_config.yml`:
|
91
83
|
|
92
84
|
Jekyll website *without* a "baseurl" (such as a GitHub Pages website for a given username):
|
93
85
|
|
@@ -117,9 +109,12 @@ title: My Jekyll Blog # Name of website
|
|
117
109
|
avatar: assets/img/triangle.png # Path of avatar image, to be displayed in the theme's header
|
118
110
|
description: My blog posts # Short description, primarily used by search engines
|
119
111
|
favicon: assets/favicon.ico # Icon displayed in the tab
|
112
|
+
color_theme: auto # color theme auto, dark or light
|
120
113
|
```
|
121
114
|
|
122
115
|
You can also customize the seo tags default option following the jekyll-seo-tag plugin [documentation](http://jekyll.github.io/jekyll-seo-tag/advanced-usage/).
|
116
|
+
The color theme can be set to dark or light (customize it in _variables.scss_).
|
117
|
+
Using _auto_ you'll have a tiny icon in the navbar allowing the use to manually switch from dark to light theme.
|
123
118
|
|
124
119
|
### Theme customization 🎨
|
125
120
|
|
@@ -140,7 +135,7 @@ If you don't want anything, replace the value by `" "`.
|
|
140
135
|
Localization string is a way to quickly change the template language for text like *Next Post* or *Follow on*, ...
|
141
136
|
You can find all the properties in `_data/language.yml`.
|
142
137
|
|
143
|
-
By default it is in english, but you can easily add your own language.
|
138
|
+
By default, it is in english, but you can easily add your own language.
|
144
139
|
|
145
140
|
### Google Analytics
|
146
141
|
|
@@ -151,16 +146,47 @@ to `_config.yml` like so:
|
|
151
146
|
google_analytics: UA-NNNNNNNN-N
|
152
147
|
```
|
153
148
|
|
154
|
-
### Comments
|
149
|
+
### Comments 💬
|
155
150
|
|
156
|
-
|
157
|
-
|
151
|
+
#### Disqus
|
152
|
+
|
153
|
+
If you have a [Disqus](https://disqus.com/) account, you can show a comments section below each post.
|
158
154
|
|
159
155
|
To enable Disqus comments, add your [Disqus shortname](https://help.disqus.com/customer/portal/articles/466208)
|
160
156
|
to your project's `_config.yml` file:
|
161
157
|
|
162
158
|
```yml
|
163
|
-
|
159
|
+
comments:
|
160
|
+
disqus_shortname: my_disqus_shortname
|
161
|
+
```
|
162
|
+
|
163
|
+
#### Cusdis
|
164
|
+
|
165
|
+
[Cusdis](https://cusdis.com/) is an open source alternative to Disqus.
|
166
|
+
You can read more about it in the [documentation](https://cusdis.com/doc#/)
|
167
|
+
|
168
|
+
To enable it, set your cusdis name in `_config.yml`:
|
169
|
+
|
170
|
+
```yaml
|
171
|
+
comments:
|
172
|
+
cusdis_app_id: my_data-app-id
|
173
|
+
```
|
174
|
+
|
175
|
+
#### Utterances
|
176
|
+
|
177
|
+
[Utterances](https://utteranc.es) is another open source alternative linked to one's GitHub account.
|
178
|
+
It stores the comments as GitHub issues on a repository for each page.
|
179
|
+
|
180
|
+
Install the utterance [app](https://github.com/apps/utterances) to your repo.
|
181
|
+
After installing, add your info in the `_config.yml`:
|
182
|
+
|
183
|
+
```yaml
|
184
|
+
comments:
|
185
|
+
utterances: # Enable by filling below information. For more info, go to https://utteranc.es
|
186
|
+
repo: # your public comments repository (e.g. owner/repo)
|
187
|
+
issue-term: # Issue term (e.g. "comment" consider issues with this word in the title as comments)
|
188
|
+
theme: # OPTIONAL: Take the `color_theme` by default, or set a custom one like github-dark-orange
|
189
|
+
label: # OPTIONAL: Adds an issue label in the issue
|
164
190
|
```
|
165
191
|
|
166
192
|
### Math typesetting with KateX
|
@@ -168,7 +194,7 @@ disqus_shortname: my_disqus_shortname
|
|
168
194
|
When KateX is set in `_config.yml`:
|
169
195
|
|
170
196
|
```yml
|
171
|
-
katex: true # to
|
197
|
+
katex: true # to enable it
|
172
198
|
```
|
173
199
|
|
174
200
|
You can then wrap math expressions with `$$` signs in your posts and make sure you have set the `katex` variable
|
@@ -213,13 +239,17 @@ sequenceDiagram
|
|
213
239
|
|
214
240
|
### Social icons
|
215
241
|
|
216
|
-
In `_data/social.yml` you can customize the social icons
|
242
|
+
In `_data/social.yml` you can customize the social icons that will be displayed in the post to share your post.
|
243
|
+
You can also enable RSS.
|
217
244
|
The site icons come from [Font Awesome](https://fontawesome.com/).
|
218
245
|
|
246
|
+
In `_data/icons.yml` you can set the footer icon that will appear at the bottom of the page.
|
247
|
+
They will redirect the user on your profile on the other platform like Twitter, GitHub and so many more!
|
248
|
+
|
219
249
|
### Cookie consent
|
220
250
|
|
221
251
|
You can add a cookie consent with a disclaimer if you use Google Analytics while respecting the [GDPR](https://en.wikipedia.org/wiki/General_Data_Protection_Regulation).
|
222
|
-
Set to true, there will be a banner at the bottom of the page with the disclaimer and
|
252
|
+
Set to true, there will be a banner at the bottom of the page with the disclaimer, and an _approve_ button.
|
223
253
|
Once the user clicks on "Approve" the cookies will be created for Google Analytics.
|
224
254
|
|
225
255
|
#### Share in article
|
@@ -254,7 +284,7 @@ Please refer to the [Jekyll docs for writing posts](https://jekyllrb.com/docs/po
|
|
254
284
|
|
255
285
|
#### Layout: Post
|
256
286
|
|
257
|
-
|
287
|
+
These are the basic features you can use with the `post` layout.
|
258
288
|
|
259
289
|
```yml
|
260
290
|
|
@@ -305,7 +335,7 @@ some text in the excerpt
|
|
305
335
|
... rest of the text not shown in the excerpt ...
|
306
336
|
```
|
307
337
|
|
308
|
-
The html is stripped out of the excerpt so it only
|
338
|
+
The html is stripped out of the excerpt, so it only displays text.
|
309
339
|
|
310
340
|
#### Image aligner
|
311
341
|
|
@@ -315,8 +345,8 @@ To easily add align images side by side in your article using the `aligner.html`
|
|
315
345
|
{% include aligner.html images="path/to/img1.png,path/to/img2.png,path/to/img3.png" column=3 %}
|
316
346
|
```
|
317
347
|
|
318
|
-
Use it in any markdown file. There are two fields in the
|
319
|
-
- _images_: Takes a string separated with `,` of all the images path.
|
348
|
+
Use it in any markdown file. There are two fields in the _include_ you need to look into:
|
349
|
+
- _images_: Takes a string separated with `,` of all the images' path.
|
320
350
|
- It by default look into `assets/img/` so give the path from there.
|
321
351
|
- _column_: (OPTIONAL) Set the number of column you want your imaged displayed in.
|
322
352
|
- default is 2 columns
|
@@ -325,7 +355,7 @@ Use it in any markdown file. There are two fields in the include you need to loo
|
|
325
355
|
|
326
356
|
#### Code highlight
|
327
357
|
|
328
|
-
Like all CSS variables in the theme, you can edit the color of the code highlight in _sass > base > _variables.scss
|
358
|
+
Like all CSS variables in the theme, you can edit the color of the code highlight in *_sass > base > _variables.scss*.
|
329
359
|
The code highlighting works with [base16](https://github.com/chriskempson/base16-html-previews/tree/master/css) you can find existing example
|
330
360
|
of your favourite highlight color scheme on this format.
|
331
361
|
|
@@ -386,7 +416,7 @@ layout: page
|
|
386
416
|
title : Portfolio
|
387
417
|
---
|
388
418
|
|
389
|
-
{% include portfolio.html %}
|
419
|
+
{% include default/portfolio.html %}
|
390
420
|
```
|
391
421
|
|
392
422
|
#### Portfolio posts
|
@@ -418,14 +448,14 @@ collections:
|
|
418
448
|
permalink: /:collection/:name
|
419
449
|
```
|
420
450
|
|
421
|
-
This creates the collection for Jekyll so it can find and display your portfolio posts.
|
451
|
+
This creates the collection for Jekyll, so it can find and display your portfolio posts.
|
422
452
|
|
423
453
|
### Feature: Gallery 🖼
|
424
454
|
|
425
455
|
You can create a gallery using [Masonry JS](https://masonry.desandro.com/) which will placing the pictures in optimal position
|
426
456
|
based on available vertical space.
|
427
457
|
You need to specify the `gallery_path` which will be used to find the pictures to render.
|
428
|
-
It will take all
|
458
|
+
It will take all the pictures under that directory. Then use the `include` to add it in your page.
|
429
459
|
|
430
460
|
```yml
|
431
461
|
|
@@ -435,14 +465,14 @@ title: Gallery
|
|
435
465
|
gallery: "assets/img/pexels"
|
436
466
|
---
|
437
467
|
|
438
|
-
{% include gallery.html gallery_path=page.gallery %}
|
468
|
+
{% include default/gallery.html gallery_path=page.gallery %}
|
439
469
|
```
|
440
470
|
|
441
471
|
|
442
472
|
### Feature: Search 🔍
|
443
473
|
|
444
474
|
The search feature is based on [Simple-Jekyll-search](https://github.com/christian-fei/Simple-Jekyll-Search)
|
445
|
-
there is a `search.json` file that will create a list of all
|
475
|
+
there is a `search.json` file that will create a list of all the site posts, pages and portfolios.
|
446
476
|
|
447
477
|
Then there's a `search.js` displaying the formatted results entered in the `search.html` page.
|
448
478
|
|
@@ -473,7 +503,7 @@ tags: [sample, markdown, html]
|
|
473
503
|
---
|
474
504
|
```
|
475
505
|
|
476
|
-
> Tags are case
|
506
|
+
> Tags are case-sensitive `Tag_nAme` ≠ `tag_name`
|
477
507
|
|
478
508
|
All the tags will be listed in `tags.html` with a link toward the pages or posts.
|
479
509
|
The Tag page can be hidden with the `hide` option. You can remove the icon by removing `icon` (like for the search page).
|
@@ -491,7 +521,9 @@ Jekyll works with [liquid](https://shopify.github.io/liquid/) tags usually repre
|
|
491
521
|
These are useful to render your jekyll files.
|
492
522
|
You can learn more about them on [shopify's doc](https://help.shopify.com/themes/liquid/basics)
|
493
523
|
|
494
|
-
###
|
524
|
+
### Gulp toolbox
|
525
|
+
|
526
|
+
#### Requirements
|
495
527
|
|
496
528
|
Before you need to have *node* and `npm` installed:
|
497
529
|
|
@@ -507,6 +539,8 @@ sudo npm install gulp-cli -g
|
|
507
539
|
npm install
|
508
540
|
```
|
509
541
|
|
542
|
+
#### Minimizing and optimizing: css, js and images
|
543
|
+
|
510
544
|
You can run the default task that will compress the js, css and images and create the thumbnails for the supported image
|
511
545
|
formats:
|
512
546
|
|
@@ -519,7 +553,19 @@ gulp thumbnails # to create thumbnails for the feature-img/ only
|
|
519
553
|
git status
|
520
554
|
```
|
521
555
|
|
522
|
-
You can find more about the gulp tasks in the [gulpfile.js](assets/gulpfile.js)
|
556
|
+
You can find more about the gulp tasks in the [gulpfile.js](assets/gulpfile.js).
|
557
|
+
|
558
|
+
#### Create a post
|
559
|
+
|
560
|
+
To create a `.md` file in the *_posts/* section with the jekyll format of today's date.
|
561
|
+
Use this command with the title you'd like to create the very basic post.
|
562
|
+
|
563
|
+
```bash
|
564
|
+
gulp post -n 'title of the post'
|
565
|
+
```
|
566
|
+
|
567
|
+
A file will be created following the format `yyyy-mm-dd-title-of-the-post.md` with default post attributes inside.
|
568
|
+
Nothing will happen if the file exists already.
|
523
569
|
|
524
570
|
### Use as Ruby Gem 💎
|
525
571
|
|
@@ -551,7 +597,7 @@ Then you can start adding content like:
|
|
551
597
|
|
552
598
|
### Remote Theme
|
553
599
|
|
554
|
-
Now you can use any theme gem with
|
600
|
+
Now you can use any theme gem with GitHub pages with [29/11/2017 Github Pages Broadcast](https://github.com/blog/2464-use-any-theme-with-github-pages).
|
555
601
|
For that remove all `theme:` attributes from `_config.yml` and add instead:
|
556
602
|
|
557
603
|
```yml
|
@@ -560,7 +606,7 @@ remote_theme: sylhare/Type-on-Strap
|
|
560
606
|
|
561
607
|
## License
|
562
608
|
|
563
|
-
This theme is licensed under the [The MIT License (MIT)](
|
609
|
+
This theme is licensed under the [The MIT License (MIT)](/LICENSE)
|
564
610
|
|
565
611
|
- Pictures from [Pexels](https://www.pexels.com/) are under Creative Commons Zero (CC0) license
|
566
612
|
- Fonts are licensed under the [SIL Open Font License (OFL)](https://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL)
|
@@ -0,0 +1,82 @@
|
|
1
|
+
# Default data to build the footer icons
|
2
|
+
# DO NOT MODIFY, use the "icons.yml" instead.
|
3
|
+
behance:
|
4
|
+
pre: "https://www.behance.net/"
|
5
|
+
bitbucket:
|
6
|
+
pre: "https://bitbucket.org/"
|
7
|
+
calendly:
|
8
|
+
pre: "https://calendly.com/"
|
9
|
+
icon: "far fa-calendar-plus"
|
10
|
+
dribbble:
|
11
|
+
pre: "https://www.dribbble.com/"
|
12
|
+
facebook:
|
13
|
+
pre: "https://www.facebook.com/"
|
14
|
+
flickr:
|
15
|
+
pre: "https://flickr.com/photos/"
|
16
|
+
github:
|
17
|
+
pre: "https://github.com/"
|
18
|
+
gitlab:
|
19
|
+
pre: "https://gitlab.com/"
|
20
|
+
google-scholar:
|
21
|
+
pre: "https://scholar.google.com/citations?hl=en&user="
|
22
|
+
icon: "fas fa-user-graduate"
|
23
|
+
instagram:
|
24
|
+
pre: "https://instagram.com/"
|
25
|
+
hacker-news:
|
26
|
+
pre: "https://news.ycombinator.com/user?id="
|
27
|
+
keybase:
|
28
|
+
pre: "https://keybase.io/"
|
29
|
+
linkedin:
|
30
|
+
pre: "https://www.linkedin.com/in/"
|
31
|
+
mail:
|
32
|
+
pre: "mailto://"
|
33
|
+
icon: "fas fa-envelope"
|
34
|
+
map:
|
35
|
+
pre: "https://www.openstreetmap.org/#map=15/"
|
36
|
+
icon: "fas fa-map-marked"
|
37
|
+
mastodon:
|
38
|
+
pre: "https://"
|
39
|
+
matrix:
|
40
|
+
pre: "https://matrix.to/#/"
|
41
|
+
icon: "fab fa-connectdevelop"
|
42
|
+
medium:
|
43
|
+
pre: "https://medium.com/@"
|
44
|
+
patreon:
|
45
|
+
pre: "https://www.patreon.com/"
|
46
|
+
phone:
|
47
|
+
pre: "tel:"
|
48
|
+
icon: "fas fa-phone"
|
49
|
+
pinterest:
|
50
|
+
pre: "https://www.pinterest.com/"
|
51
|
+
reddit:
|
52
|
+
pre: "https://www.reddit.com/user/"
|
53
|
+
soundcloud:
|
54
|
+
pre: "https://soundcloud.com/"
|
55
|
+
sms:
|
56
|
+
pre: "sms:"
|
57
|
+
pos: "?body=Hi"
|
58
|
+
icon: "fas fa-sms"
|
59
|
+
stack-exchange:
|
60
|
+
pre: "https://stackexchange.com/users/"
|
61
|
+
stack-overflow:
|
62
|
+
pre: "https://stackoverflow.com/users/"
|
63
|
+
steam:
|
64
|
+
pre: "https://steamcommunity.com/id/"
|
65
|
+
telegram:
|
66
|
+
pre: "https://t.me/"
|
67
|
+
tumblr:
|
68
|
+
pre: "https://"
|
69
|
+
pos: ".tumblr.com/"
|
70
|
+
twitch:
|
71
|
+
pre: "https://twitch.tv/"
|
72
|
+
twitter:
|
73
|
+
pre: "https://twitter.com/"
|
74
|
+
vimeo:
|
75
|
+
pre: "https://vimeo.com/"
|
76
|
+
vk:
|
77
|
+
pre: "https://vk.com/"
|
78
|
+
wordpress:
|
79
|
+
pre: "https://"
|
80
|
+
pos: ".wordpress.com/"
|
81
|
+
youtube:
|
82
|
+
pre: "https://www.youtube.com/channel/"
|
data/_data/language.yml
CHANGED
@@ -14,3 +14,7 @@ str_javascript_required_disqus: "Please enable JavaScript to view comments."
|
|
14
14
|
str_no_result_found: "No result found"
|
15
15
|
str_cookie_approve: "Approve"
|
16
16
|
str_cookie_disclaimer: "We would like to use third party cookies and scripts to improve the functionality of this website."
|
17
|
+
str_months: [January, February, March, April, May, June, July, August, September, October, November, December]
|
18
|
+
|
19
|
+
# Localization settings
|
20
|
+
cusdis_lang: # zh-cn, es, tr, pt-BR
|
@@ -1,4 +1,7 @@
|
|
1
1
|
<div class="posts">
|
2
|
+
{% unless paginator.posts %}
|
3
|
+
<article><section class="post-content"><p>There are no blog posts</p></section></article>
|
4
|
+
{% endunless %}
|
2
5
|
{% for post in paginator.posts %}
|
3
6
|
<div class="post-teaser">
|
4
7
|
{% if post.thumbnail %}
|
@@ -15,7 +18,7 @@
|
|
15
18
|
{{ post.title }}
|
16
19
|
</a>
|
17
20
|
</h1>
|
18
|
-
{% include post_info.html author=post.author date=post.date %}
|
21
|
+
{% include blog/post_info.html author=post.author date=post.date %}
|
19
22
|
</header>
|
20
23
|
{% if site.excerpt or site.theme_settings.excerpt %}
|
21
24
|
<div class="excerpt">
|
@@ -31,4 +34,4 @@
|
|
31
34
|
{% endfor %}
|
32
35
|
</div>
|
33
36
|
|
34
|
-
{% include blog_nav.html %}
|
37
|
+
{% include blog/blog_nav.html %}
|