arthr.me
A charming Jekyll theme.
jekyll-theme
docs: update theme docs
authored by
+65
-28
+65
-28
README.md
+65
-28
README.md
···
1
-
# Linus
1
+
---
2
+
layout: page
3
+
title: Using Linus
4
+
permalink: /about/
5
+
---
2
6
3
-
A minimal Jekyll blog theme. Supports link posts, categories, tags, date archives, pagination, and dark mode out of the box.
4
-
7
+
Linus is a minimal blog theme for Jekyll. Supports link posts, categories, tags, archives (using [jekyll-archives](https://github.com/jekyll/jekyll-arcihves)) and dark mode out of the box.
5
8
## Installation
6
9
7
10
Add this line to your Jekyll site's `Gemfile`:
···
51
54
---
52
55
```
53
56
54
-
**Link posts** — set `title` to an empty string and provide a `source` URL. The post title renders as "↪ [fetched page title]" using `jekyll-url-metadata`:
57
+
**Link posts**: you can have link posts by setting a `post.source` front-matter on your post. If the title is left empty (`""`), Jekyll will try to fetch the link metadata and render the link title as your post title.
55
58
56
59
```yaml
57
60
---
···
64
67
65
68
### Authors
66
69
67
-
Define authors in `_data/authors.yml`:
70
+
Authors follow the same approach as [jekyll-feed](https://github.com/jekyll-feed) and [jekyll-archives](https://github.com/jekyll/jekyll-archives). You can have an author object set in a post, or in the site `_config.yml`, or in a `authors.yml` data file.
71
+
72
+
In a post:
68
73
69
74
```yaml
70
-
arthur:
71
-
name: Arthur Freitas
72
-
uri: https://arthr.me/
75
+
---
76
+
layout: post
77
+
title: My awesome first post
78
+
author:
79
+
name: Author Name
80
+
uri: https://example.com
81
+
picture: /path/to/author-picture.jpg
82
+
---
73
83
```
74
84
75
-
Reference them in post front matter with the `author` key.
85
+
In your `_config.yml`:
76
86
77
-
### Category colors
87
+
```yaml
88
+
author:
89
+
name: Author Name
90
+
uri: https://example.com
91
+
picture: /path/to/author-picture.jpg
92
+
```
78
93
79
-
Assign a background color to each category pill:
94
+
You can also define authors in `_data/authors.yml`:
80
95
81
96
```yaml
82
-
category_colors:
83
-
- name: Links
84
-
color: "#f0e68c"
85
-
- name: Notes
86
-
color: "#fa8072"
97
+
author_name:
98
+
name: Author Name
99
+
uri: https://example.com
100
+
picture: /path/to/author-picture.jpg
87
101
```
88
102
89
-
### Date formats
90
-
91
-
Customize how dates are displayed using strftime strings:
103
+
Reference them in post front matter with the `author` key:
92
104
93
105
```yaml
94
-
date_formats:
95
-
day: "%b %d, '%y"
96
-
month: "%b, '%y"
97
-
year: "%Y"
106
+
author: author_name
98
107
```
99
108
100
109
### Navigation menus
···
126
135
127
136
```yaml
128
137
translations:
138
+
byline: "By"
129
139
archive_date_title: "Archives from %date"
130
140
archive_tag_title: "Posts tagged with %tag"
131
141
archive_category_title: "Posts filed under %category"
···
134
144
blog_pagination_next_page: "Next page"
135
145
```
136
146
137
-
### Pagination
147
+
### Further options
148
+
149
+
Linus uses the following Jekyll plugins, which you can set up as you please. Refer to the plugins docs to learn how to change the way your site will handle pagination, archiving, feeds and SEO tags:
138
150
139
-
```yaml
140
-
paginate: 12
141
-
paginate_path: "/pg/:num/"
142
-
```
151
+
- [jekyll-pagination](https://github.com/jekyll/jekyll-pagination)
152
+
- [jekyll-archives](https://github.com/jekyll/jekyll-archives)
153
+
- [jekyll-seo-tag](https://github.com/jekyll/jekyll-seo-tag)
154
+
- [jekyll-sitemap](https://github.com/jekyll/jekyll-sitemap)
155
+
- [jekyll-feed](https://github.com/jekyll/jekyll-feed)
156
+
- [jekyll-json-feed](https://github.com/lildude/jekyll-json-feed)
143
157
144
158
## Customization
145
159
160
+
### Date formats
161
+
162
+
Customize how dates are displayed using strftime strings:
163
+
164
+
```yaml
165
+
date_formats:
166
+
day: "%b %d, '%y"
167
+
month: "%b, '%y"
168
+
year: "%Y"
169
+
```
170
+
146
171
### Custom styles
147
172
148
173
Override or extend the theme's CSS by creating `assets/css/theme.css` in your site. This file is loaded last, after all theme styles. Use it to redefine CSS custom properties or add new rules:
···
152
177
--font-body: Georgia, serif;
153
178
--color-accent: tomato;
154
179
}
180
+
```
181
+
182
+
#### Category colors
183
+
184
+
Assign a background color to each category pill:
185
+
186
+
```yaml
187
+
category_colors:
188
+
- name: Links
189
+
color: "#f0e68c"
190
+
- name: Notes
191
+
color: "#fa8072"
155
192
```
156
193
157
194
### Custom fonts