Skip to content

Commit 49cacda

Browse files
committed
Update documentation
1 parent e4f3439 commit 49cacda

File tree

1 file changed

+23
-17
lines changed

1 file changed

+23
-17
lines changed

README.md

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,7 @@ Based on Rohan Chandra [type-theme](https://github.com/rohanchandra/type-theme)
2727
2828
## Usage
2929

30-
### As a ruby gem 💎
31-
32-
Check out this tutorial: [Use as Ruby Gem](#use-as-ruby-gem-)
33-
34-
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#/https://github.com/sylhare/Type-On-Strap)
35-
36-
### As a github page 📋
30+
### As a GitHub page 📋
3731

3832
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`
3933
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-)
4236
- GitHub Page: [update `_config.yml`](#site-configuration)
4337
5. Run the Jekyll server: `bundle exec jekyll serve`
4438

39+
### As a ruby gem 💎
40+
41+
Check out this tutorial: [Use as Ruby Gem](#use-as-ruby-gem-)
42+
43+
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#/https://github.com/sylhare/Type-On-Strap)
44+
4545
## Structure
4646

4747
Here are the main files of the template
@@ -165,9 +165,10 @@ with suffix `-small` (620x320) and `-medium` (1240x640) to display on smaller sc
165165
Localization string is a way to quickly change the template language for text like *Next Post* or *Follow on*, ...
166166
You can find all the properties in `_data/language.yml`.
167167

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.
169169

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.
171172

172173
### Google Analytics
173174

@@ -295,7 +296,8 @@ Display icons in the footer.
295296
All icon variables should be your username enclosed in quotes (e.g. "username") in `_data/icons.yml`.
296297

297298
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.
299301

300302
### Personalize your Blog Posts 📝
301303

@@ -318,7 +320,7 @@ title: Hello World # Title of the page
318320
hide_title: true # [Opt] Hide the title when displaying the post, but shown in lists of posts
319321
feature-img: "assets/img/sample.png" # [Opt] Add a feature-image to the post
320322
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
322324
position: 1 # [Opt] Set position on the menu navigation bar
323325
tags: [sample, markdown, html] # [Opt] Add tags to the page
324326
---
@@ -339,7 +341,7 @@ It will respect the page and theme layout, mind the padding on the sides.
339341

340342
#### Post excerpt
341343

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.
343345
The length of the excerpt has a default of around `250` characters or can be manually set in the post using:
344346

345347
in `conflig.yml`:
@@ -369,8 +371,12 @@ The html is stripped out of the excerpt, so it only displays text.
369371

370372
To easily add align images side by side in your article using the `aligner.html` include:
371373

372-
```ruby
373-
{% include aligner.html images="path/to/img1.png,path/to/img2.png,path/to/img3.png" column=3 %}
374+
```liquid
375+
{% include aligner.html
376+
images="path/to/img1.png,path/to/img2.png,path/to/img3.png"
377+
column=3
378+
caption="some description"
379+
%}
374380
```
375381

376382
Use it in any markdown file. There are two fields in the _include_ you need to look into:
@@ -546,7 +552,7 @@ The Tag page can be hidden with the `hide` option. You can remove the icon by re
546552

547553
Jekyll works with [liquid](https://shopify.github.io/liquid/) tags usually represented by:
548554

549-
```
555+
```liquid
550556
{{ liquid.tag | filter }}
551557
```
552558

@@ -606,7 +612,7 @@ You can use Type-on-strap as a [gem](https://rubygems.org/gems/type-on-strap).
606612
Using the [Ruby Gem Method](https://sylhare.github.io/2021/03/25/Run-type-on-strap-jekyll-theme-locally.html).
607613
Add this line to your Jekyll site's Gemfile (or create one):
608614

609-
```ruby
615+
```shell
610616
gem "type-on-strap"
611617
```
612618

@@ -618,7 +624,7 @@ theme: type-on-strap
618624

619625
Then run Bundler to install the theme gem and dependencies:
620626

621-
```bash
627+
```shell
622628
bundle install
623629
```
624630

0 commit comments

Comments
 (0)