simple-gh-pages-theme 0.1.0 → 0.1.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +74 -16
- data/_layouts/category-posts.html +11 -9
- data/assets/css/main.scss +2 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: b7b807d8c650f10418abcc0c706ffd1c650507409b2ef50a4a6f278333a22622
|
|
4
|
+
data.tar.gz: 973d492bd1fa490a39071abfbc1bcbd1454caa6064be5f62194c99d3e8b84d9d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 47549fede30cf7138a9393174e48757585a4d96d1fa79eee44ef12dfa30945cd028b1f95388e42861106d42238a6fe09c41ef25fcae0040af9deb9928c7f893d
|
|
7
|
+
data.tar.gz: ce01829d02aa82aa0abc54af35291121ac55c47239824ade736ce189a75a480b5dc3a352a514ce98286f8895c7e72f3d5dbf9743f3fd5beee058439fbcc2eed8
|
data/README.md
CHANGED
|
@@ -1,49 +1,107 @@
|
|
|
1
1
|
# simple-gh-pages-theme
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
3
|
+
<table>
|
|
4
|
+
<tr><td>
|
|
5
|
+
<img width="500" alt="empty default" src="https://user-images.githubusercontent.com/5443727/229302809-750132e5-d461-4ec8-a38a-ccdc62b3b72e.png">
|
|
6
|
+
</td><td>
|
|
7
|
+
<img width="500" alt="jordiwippert.nl" src="https://user-images.githubusercontent.com/5443727/229302812-d481eb40-b0ca-49cd-95d5-c7fef5228b7a.png">
|
|
8
|
+
</td>
|
|
9
|
+
<tr>
|
|
10
|
+
<td>
|
|
11
|
+
simple-gh-pages-theme, after install and first post setup
|
|
12
|
+
</td>
|
|
13
|
+
<td>
|
|
14
|
+
in-use
|
|
15
|
+
</td>
|
|
16
|
+
</tr>
|
|
17
|
+
</table>
|
|
8
18
|
|
|
9
19
|
## Installation
|
|
10
20
|
|
|
11
21
|
Add this line to your Jekyll site's `Gemfile`:
|
|
12
|
-
|
|
13
22
|
```ruby
|
|
14
23
|
gem "simple-gh-pages-theme"
|
|
15
24
|
```
|
|
16
25
|
|
|
17
|
-
And add this line to your Jekyll site's `_config.yml
|
|
18
|
-
|
|
26
|
+
And add this line to your Jekyll site's `_config.yml`. Remove/disable possibly already enabled themes:
|
|
19
27
|
```yaml
|
|
20
28
|
theme: simple-gh-pages-theme
|
|
21
29
|
```
|
|
22
30
|
|
|
23
31
|
And then execute:
|
|
32
|
+
```shell
|
|
33
|
+
bundle
|
|
34
|
+
OR
|
|
35
|
+
gem install simple-gh-pages-theme
|
|
36
|
+
```
|
|
37
|
+
### !!! Important. To make the layouts work properly.
|
|
24
38
|
|
|
25
|
-
|
|
39
|
+
If you created a new website (`jekyll new sitename`), you can make your pages use the layout by changing:
|
|
26
40
|
|
|
27
|
-
|
|
41
|
+
- **index.markdown**:
|
|
42
|
+
```
|
|
43
|
+
---
|
|
44
|
+
layout: index
|
|
45
|
+
---
|
|
46
|
+
```
|
|
47
|
+
- **about.markdown**:
|
|
48
|
+
```
|
|
49
|
+
---
|
|
50
|
+
layout: post
|
|
51
|
+
permalink: /about.html
|
|
52
|
+
---
|
|
53
|
+
```
|
|
54
|
+
- **posts.markdown**: (file might not exist yet)
|
|
55
|
+
```
|
|
56
|
+
---
|
|
57
|
+
layout: posts
|
|
58
|
+
---
|
|
59
|
+
```
|
|
60
|
+
- **404.markdown**: (file might not exist yet)
|
|
61
|
+
```
|
|
62
|
+
---
|
|
63
|
+
layout: 404
|
|
64
|
+
---
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## Configuration:
|
|
28
68
|
|
|
29
|
-
|
|
69
|
+
See/use example config [here](https://github.com/LiveNL/simple-gh-pages-theme/blob/main/example-config.yml). Copy to `_config.yml`
|
|
30
70
|
|
|
31
71
|
## Usage
|
|
72
|
+
### Posts
|
|
32
73
|
|
|
33
|
-
|
|
74
|
+
Create your posts like:
|
|
34
75
|
|
|
35
|
-
|
|
76
|
+
```
|
|
77
|
+
docs/_posts/published/yyyy-mm-dd-postname.md
|
|
78
|
+
```
|
|
36
79
|
|
|
37
|
-
|
|
80
|
+
Each post can have the following options (with defaults):
|
|
81
|
+
|
|
82
|
+
```
|
|
83
|
+
layout: post
|
|
84
|
+
title: "Title here"
|
|
85
|
+
image: assets/images/image.png OR https://example.com/image.png
|
|
86
|
+
categories: [category]
|
|
87
|
+
tags: [tag]
|
|
88
|
+
highlight: false (if true: it will be used on about page, more here)
|
|
89
|
+
short: false (if true: it shown in 'short' list on home page)
|
|
90
|
+
list_post: false (if true: it shown in list on home/posts page)
|
|
91
|
+
```
|
|
38
92
|
|
|
39
93
|
## Development
|
|
40
94
|
|
|
41
95
|
To set up your environment to develop this theme, run `bundle install`.
|
|
42
96
|
|
|
43
|
-
|
|
97
|
+
To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`.
|
|
98
|
+
|
|
99
|
+
This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
|
|
44
100
|
|
|
45
101
|
When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
|
|
46
|
-
|
|
102
|
+
|
|
103
|
+
## Contributing
|
|
104
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/lvenl/simple-gh-pages-theme. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://www.contributor-covenant.org/) code of conduct.
|
|
47
105
|
|
|
48
106
|
## License
|
|
49
107
|
|
|
@@ -3,19 +3,21 @@ layout: default
|
|
|
3
3
|
title: categories
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
<div class="
|
|
7
|
-
|
|
8
|
-
|
|
6
|
+
<div class="content">
|
|
7
|
+
<div class="posts-all">
|
|
8
|
+
<!-- prettier-ignore -->
|
|
9
|
+
{% assign selection = page.posts | where_exp:"post", "post.list_post == true" %}
|
|
9
10
|
{% for post in selection %}
|
|
10
11
|
{% include post-list-item.html %}
|
|
11
12
|
{% assign nr_of_posts = nr_of_posts | plus:1 %}
|
|
12
13
|
{% endfor %}
|
|
13
|
-
</div>
|
|
14
|
-
|
|
15
|
-
<div class="sidebar-short">
|
|
16
|
-
<div class="div-subtitle">
|
|
17
|
-
<h4>{{nr_of_posts}} posts with {{ page.type }} '{{ page.title }}'</h4>
|
|
18
14
|
</div>
|
|
19
15
|
|
|
20
|
-
|
|
16
|
+
<div class="sidebar-short">
|
|
17
|
+
<div class="div-subtitle">
|
|
18
|
+
<h4>{{nr_of_posts}} posts with {{ page.type }} '{{ page.title }}'</h4>
|
|
19
|
+
</div>
|
|
20
|
+
|
|
21
|
+
{% include sidebar-categories.html %}
|
|
22
|
+
</div>
|
|
21
23
|
</div>
|
data/assets/css/main.scss
CHANGED