You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+23-17Lines changed: 23 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,13 +27,7 @@ Based on Rohan Chandra [type-theme](https://github.com/rohanchandra/type-theme)
27
27
28
28
## Usage
29
29
30
-
### As a ruby gem 💎
31
-
32
-
Check out this tutorial: [Use as Ruby Gem](#use-as-ruby-gem-)
33
-
34
-
[](https://gitpod.io/#/https://github.com/sylhare/Type-On-Strap)
35
-
36
-
### As a github page 📋
30
+
### As a GitHub page 📋
37
31
38
32
1. Fork and clone the [Type on Strap repo](https://github.com/sylhare/Type-On-Strap): `git clone https://github.com/Sylhare/Type-on-Strap.git`
39
33
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.
@@ -42,6 +36,12 @@ Check out this tutorial: [Use as Ruby Gem](#use-as-ruby-gem-)
5. Run the Jekyll server: `bundle exec jekyll serve`
44
38
39
+
### As a ruby gem 💎
40
+
41
+
Check out this tutorial: [Use as Ruby Gem](#use-as-ruby-gem-)
42
+
43
+
[](https://gitpod.io/#/https://github.com/sylhare/Type-On-Strap)
44
+
45
45
## Structure
46
46
47
47
Here are the main files of the template
@@ -165,9 +165,10 @@ with suffix `-small` (620x320) and `-medium` (1240x640) to display on smaller sc
165
165
Localization string is a way to quickly change the template language for text like *Next Post* or *Follow on*, ...
166
166
You can find all the properties in `_data/language.yml`.
167
167
168
-
By default, it is in English, but you can easily add your own language.
168
+
By default, it is in English, but you can add your own language.
169
169
170
-
Here you also can set the date format, e.g., set `str_date_format: '%B %-d, %Y'` for "January, 13, 2024", `str_date_format: '%Y-%m-%d'` for 2024-01-13, or `str_date_format: '%d.%m.%Y'` for 13.01.2024.
170
+
Here you also can set the date format, e.g., set `str_date_format: '%B %-d, %Y'` for "January, 13, 2024",
171
+
`str_date_format: '%Y-%m-%d'` for 2024-01-13, or `str_date_format: '%d.%m.%Y'` for 13.01.2024.
171
172
172
173
### Google Analytics
173
174
@@ -295,7 +296,8 @@ Display icons in the footer.
295
296
All icon variables should be your username enclosed in quotes (e.g. "username") in `_data/icons.yml`.
296
297
297
298
You can update the RSS settings in `_data/social` to change the default feed path (generated by [jekyll-feel](https://github.com/jekyll/jekyll-feed)).
298
-
To enable the share icons at the bottom of each article set to true the one you'd like under `share` in the `_data/social.yml` file.
299
+
To enable the share icons at the bottom of each article,
300
+
set to true the one you'd like under `share` in the `_data/social.yml` file.
299
301
300
302
### Personalize your Blog Posts 📝
301
303
@@ -318,7 +320,7 @@ title: Hello World # Title of the page
318
320
hide_title: true # [Opt] Hide the title when displaying the post, but shown in lists of posts
319
321
feature-img: "assets/img/sample.png" # [Opt] Add a feature-image to the post
320
322
thumbnail: "assets/img/thumbnails/sample-th.png" # [Opt] Add a thumbnail image on blog view
321
-
color: rgb(80,140,22) # [Opt] Add the specified colour as feature image, and change link colors in post
323
+
color: rgb(80,140,22) # [Opt] Add the specified color as feature image and links in post
322
324
position: 1 # [Opt] Set position on the menu navigation bar
323
325
tags: [sample, markdown, html] # [Opt] Add tags to the page
324
326
---
@@ -339,7 +341,7 @@ It will respect the page and theme layout, mind the padding on the sides.
339
341
340
342
#### Post excerpt
341
343
342
-
The [excerpt](https://jekyllrb.com/docs/posts/#post-excerpts) are the first lines of an article that is displayed on the blog page.
344
+
The [excerpt](https://jekyllrb.com/docs/posts/#post-excerpts) is the head of the article rendered in the blog page.
343
345
The length of the excerpt has a default of around `250` characters or can be manually set in the post using:
344
346
345
347
in `conflig.yml`:
@@ -369,8 +371,12 @@ The html is stripped out of the excerpt, so it only displays text.
369
371
370
372
To easily add align images side by side in your article using the `aligner.html` include:
371
373
372
-
```ruby
373
-
{% include aligner.html images="path/to/img1.png,path/to/img2.png,path/to/img3.png" column=3 %}
0 commit comments