Skip to content

Commit 306979a

Browse files
authored
Merge pull request #410 from sylhare/doc
Update documentation
2 parents f531e82 + 9e461b5 commit 306979a

2 files changed

Lines changed: 14 additions & 13 deletions

File tree

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66

77
[![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/)
88

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:
9+
A free and open-source [Jekyll](https://jekyllrb.com) theme.
10+
Based on Rohan Chandra [type-theme](https://github.com/rohanchandra/type-theme) packed with extra features and easily customizable:
1011

1112
* Responsive design on all devices (🖥, 💻, 📱, ...)
1213
* Portfolio 🗂, Gallery 🖼 pages for your projects
@@ -46,7 +47,7 @@ Check out this tutorial: [Use as Ruby Gem](#use-as-ruby-gem-)
4647
Here are the main files of the template
4748

4849
```shell
49-
Type-on-Strap
50+
./Type-on-Strap
5051
├── _includes # Theme includes
5152
├── _layouts # Theme layouts (see below for details)
5253
├── _portfolio # Collection of articles for the portfolio page
@@ -116,8 +117,8 @@ To configure the blog part and default plugins. Those plugins are validated by G
116117

117118
#### Meta and Branding
118119

119-
Meta variables hold basic information about your Jekyll site which will be used throughout the site
120-
and as meta properties that are used for search engines, browsers, and the site's RSS feed.
120+
_Meta variables_ hold basic information about your Jekyll site, which will be used throughout the site
121+
and as _meta properties_ that are used for search engines, browsers, and the site's RSS feed.
121122

122123
Change these variables in `_config.yml`:
123124

@@ -135,7 +136,7 @@ Using _auto_ you'll have a tiny icon in the navbar allowing the use to manually
135136

136137
### Theme customization 🎨
137138

138-
#### Footer and Header's text
139+
#### Footer and Header text
139140

140141
Customize your site header/footer with these variables in `_config.yml`:
141142

@@ -164,7 +165,7 @@ with suffix `-small` (620x320) and `-medium` (1240x640) to display on smaller sc
164165
Localization string is a way to quickly change the template language for text like *Next Post* or *Follow on*, ...
165166
You can find all the properties in `_data/language.yml`.
166167

167-
By default, it is in english, but you can easily add your own language.
168+
By default, it is in English, but you can easily add your own language.
168169

169170
### Google Analytics
170171

@@ -193,10 +194,10 @@ comments:
193194

194195
#### Cusdis
195196

196-
[Cusdis](https://cusdis.com/) is an open source alternative to Disqus.
197+
[Cusdis](https://cusdis.com/) is an open-source alternative to Disqus.
197198
You can read more about it in the [documentation](https://cusdis.com/doc#/)
198199

199-
To enable it, set your cusdis name in `_config.yml`:
200+
To enable it, set your Cusdis name in `_config.yml`:
200201

201202
```yaml
202203
comments:
@@ -275,7 +276,7 @@ You can also enable RSS.
275276
The site icons come from [Font Awesome](https://fontawesome.com/).
276277

277278
In `_data/icons.yml` you can set the footer icon that will appear at the bottom of the page.
278-
They will redirect the user on your profile on the other platform like Twitter, GitHub and so many more!
279+
They will redirect the user on your profile on to other platforms like Twitter, GitHub and so many more!
279280

280281
### Cookie consent
281282

@@ -618,7 +619,7 @@ Then you can start adding content like:
618619

619620
### Remote Theme
620621

621-
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).
622+
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).
622623
For that remove all `theme:` attributes from `_config.yml` and add instead:
623624

624625
```yml
@@ -627,7 +628,7 @@ remote_theme: sylhare/Type-on-Strap
627628

628629
## License
629630

630-
This theme is licensed under the [The MIT License (MIT)](/LICENSE)
631+
This theme is licensed under the [MIT License (MIT)](/LICENSE)
631632

632633
- Pictures from [Pexels](https://www.pexels.com/) are under Creative Commons Zero (CC0) license
633634
- Fonts are licensed under the [SIL Open Font License (OFL)](https://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL)

_config.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,11 @@ color_image: /assets/img/lineart.png # A bit transparent for
2525
# For layout customization, go to the "_sass > base" folder, and check "_variables.scss"
2626
katex: true # Enable if using math markup
2727
mermaid: default # Enable mermaid-js for diagrams, use theme: base, forest, dark, default, neutral
28-
google_analytics: # Tracking ID, e.g. "UA-000000-01"
28+
google_analytics: # Measurement ID, e.g. "G-00000"
2929
cookie_consent: false # To respect the usage of cookies
3030
color_theme: auto # auto, dark or light
3131

32-
# Comments
32+
# Comments options
3333
comments:
3434
disqus_shortname: # Your discus shortname for comments
3535
cusdis_app_id: # Your cusdis data-app-id

0 commit comments

Comments
 (0)