simple-gh-pages-theme 0.1.0 → 0.1.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +41 -8
- data/_config.yml +60 -0
- data/_layouts/category-posts.html +11 -9
- data/assets/css/main.scss +2 -1
- metadata +2 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 0ed0b3abadfdeb7321a6a2efaf687b91e36b5ce1161799c695f2b20246ee99d6
|
|
4
|
+
data.tar.gz: 3814d56bf98da478731ed1d9fea3b9dd537ff178f731e9424a50c40220e67339
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 8775ea0c3b815ff9b9bfaade1ee8f493682f727ec7974b5c78797c12d3114b7475bb224e36e20bf5d355c0da94ca0d2c91252e7f1314ded89b1d565bf05dee5a
|
|
7
|
+
data.tar.gz: d1e3e7b58deccf8cad9450589da09d4f54709a18b03e81ab5ae91781b8b3c79ccd7675204e66d0abb4c4f1f19002bade4da1396e39fc79de03352c6acd91f2e9
|
data/README.md
CHANGED
|
@@ -1,11 +1,5 @@
|
|
|
1
1
|
# simple-gh-pages-theme
|
|
2
2
|
|
|
3
|
-
Welcome to your new Jekyll theme! In this directory, you'll find the files you need to be able to package up your theme into a gem. Put your layouts in `_layouts`, your includes in `_includes`, your sass files in `_sass` and any other assets in `assets`.
|
|
4
|
-
|
|
5
|
-
To experiment with this code, add some sample content and run `bundle exec jekyll serve` – this directory is setup just like a Jekyll site!
|
|
6
|
-
|
|
7
|
-
TODO: Delete this and the text above, and describe your gem
|
|
8
|
-
|
|
9
3
|
## Installation
|
|
10
4
|
|
|
11
5
|
Add this line to your Jekyll site's `Gemfile`:
|
|
@@ -28,13 +22,52 @@ Or install it yourself as:
|
|
|
28
22
|
|
|
29
23
|
$ gem install simple-gh-pages-theme
|
|
30
24
|
|
|
25
|
+
### !!! Important. To make the layouts work properly.
|
|
26
|
+
|
|
27
|
+
If you created a new website (`jekyll new sitename`), you can make your pages use the layout by changing:
|
|
28
|
+
|
|
29
|
+
- **index.markdown**: to `layout: index`
|
|
30
|
+
- **posts.markdown**: to `layout: posts` (file might not exist yet)
|
|
31
|
+
- **404.markdown**: to `layout: 404` (file might not exist yet)
|
|
32
|
+
|
|
33
|
+
Like:
|
|
34
|
+
|
|
35
|
+
```
|
|
36
|
+
---
|
|
37
|
+
layout: index
|
|
38
|
+
---
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Configuration:
|
|
42
|
+
|
|
43
|
+
See example config [here](https://github.com/LiveNL/simple-gh-pages-theme/blob/main/_config.yml)
|
|
44
|
+
|
|
31
45
|
## Usage
|
|
32
46
|
|
|
33
|
-
|
|
47
|
+
### Posts
|
|
48
|
+
|
|
49
|
+
Create your posts like:
|
|
50
|
+
|
|
51
|
+
```
|
|
52
|
+
docs/_posts/published/yyyy-mm-dd-postname.md
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
Each post can have the following options (with defaults):
|
|
56
|
+
|
|
57
|
+
```
|
|
58
|
+
layout: post
|
|
59
|
+
title: "Title here"
|
|
60
|
+
image: assets/images/image.png OR https://example.com/image.png
|
|
61
|
+
categories: [category]
|
|
62
|
+
tags: [tag]
|
|
63
|
+
highlight: false (if true: it will be used on about page, more here)
|
|
64
|
+
short: false (if true: it shown in 'short' list on home page)
|
|
65
|
+
list_post: false (if true: it shown in list on home/posts page)
|
|
66
|
+
```
|
|
34
67
|
|
|
35
68
|
## Contributing
|
|
36
69
|
|
|
37
|
-
Bug reports and pull requests are welcome on GitHub at https://github.com/
|
|
70
|
+
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.
|
|
38
71
|
|
|
39
72
|
## Development
|
|
40
73
|
|
data/_config.yml
ADDED
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
theme: simple-gh-pages-theme
|
|
2
|
+
title: My website
|
|
3
|
+
description: The website description
|
|
4
|
+
domain: "username.github.io"
|
|
5
|
+
baseurl: "https://example.com"
|
|
6
|
+
url: "https://example.com"
|
|
7
|
+
gtag: "G-XXXXXXXXX" (your google tag)
|
|
8
|
+
|
|
9
|
+
about:
|
|
10
|
+
name: Firstname Lastname
|
|
11
|
+
site: "https://example.com"
|
|
12
|
+
avatar: assets/images/image.png
|
|
13
|
+
email: example@example.com
|
|
14
|
+
socials:
|
|
15
|
+
twitter: https://twitter.com/example
|
|
16
|
+
linkedin: https://www.linkedin.com/in/example/
|
|
17
|
+
github: https://github.com/example
|
|
18
|
+
keybase: https://keybase.io/example
|
|
19
|
+
medium: https://medium.com/@example
|
|
20
|
+
stack-overflow: https://stackoverflow.com/users/xxxxxx/example
|
|
21
|
+
|
|
22
|
+
plugins:
|
|
23
|
+
- jekyll-archives
|
|
24
|
+
- jekyll-redirect-from
|
|
25
|
+
- jekyll-sitemap
|
|
26
|
+
|
|
27
|
+
jekyll-archives:
|
|
28
|
+
enabled:
|
|
29
|
+
- tags
|
|
30
|
+
- categories
|
|
31
|
+
layout: category-posts
|
|
32
|
+
permalinks:
|
|
33
|
+
year: "/:year/"
|
|
34
|
+
month: "/:year/:month/"
|
|
35
|
+
day: "/:year/:month/:day/"
|
|
36
|
+
tag: "/tag/:name/"
|
|
37
|
+
category: "/category/:name/"
|
|
38
|
+
|
|
39
|
+
defaults:
|
|
40
|
+
- scope:
|
|
41
|
+
path: "assets/**"
|
|
42
|
+
values:
|
|
43
|
+
sitemap: false
|
|
44
|
+
|
|
45
|
+
sass:
|
|
46
|
+
sass_dir: _sass
|
|
47
|
+
|
|
48
|
+
# Excluded items can be processed by explicitly listing the directories or
|
|
49
|
+
# their entries' file path in the `include:` list.
|
|
50
|
+
exclude:
|
|
51
|
+
- .sass-cache/
|
|
52
|
+
- .jekyll-cache/
|
|
53
|
+
- gemfiles/
|
|
54
|
+
- Gemfile
|
|
55
|
+
- Gemfile.lock
|
|
56
|
+
- node_modules/
|
|
57
|
+
- vendor/bundle/
|
|
58
|
+
- vendor/cache/
|
|
59
|
+
- vendor/gems/
|
|
60
|
+
- vendor/ruby/
|
|
@@ -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
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: simple-gh-pages-theme
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.1.
|
|
4
|
+
version: 0.1.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- LiveNL
|
|
@@ -61,6 +61,7 @@ extra_rdoc_files: []
|
|
|
61
61
|
files:
|
|
62
62
|
- LICENSE.txt
|
|
63
63
|
- README.md
|
|
64
|
+
- _config.yml
|
|
64
65
|
- _data/navigation.yml
|
|
65
66
|
- _includes/highlights.html
|
|
66
67
|
- _includes/intro.html
|