jekyll-theme-dusk 0.2.5 → 0.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (6) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +87 -43
  3. data/_includes/image-gallery.html +1 -1
  4. data/_sass/base.scss +24 -26
  5. data/_sass/include.scss +1 -1
  6. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 0aaddb7cdb1b910335bd0a657c733cc741d711d5baaff9dee8a8261ec39dcca1
4
- data.tar.gz: 97bf2558d4113fe0c418c8a0de7959198b65a48a5ad42e7475a85977d176e466
3
+ metadata.gz: 7c574dec7eb61d1205bccd0b91e37ec534fd8928e0baa7770c037ade764bf0cc
4
+ data.tar.gz: d0138df09ec3af24901e8c79be3d50f767008646fcbbf4dc82849e68b9a45c79
5
5
  SHA512:
6
- metadata.gz: 364219768d8342d5d545eb3a6ad4f4ef84c443a71200e3fba9658a197cbbfee443280cdbde6d2c31ada0cc6e84fde926fd1d18a423ff3734a4798499118bf7f8
7
- data.tar.gz: 929dced2ffe00192bcfa8fc7b3fb0c10ef72cce825356fd6d7cd62c1ef3b92b3a408927d1c3f6d83061fcdf067bf3daec702d3316b54698a88147b36930bf933
6
+ metadata.gz: 683b8edcecde6b6dfebcdd7d4527471a0224fd7690ebaf676c1305af7caa04892977fa2475c35d07b054314d957c960fbfc8d6b9e35a1631204a4c221ca88bbe
7
+ data.tar.gz: 4769f51453d6ffb069db3cf4343c1779f0aff56f2ceaf04f68c7e8fa337c6dacf5d1bcfb030d7c49359ff103fede7bcdd92c41a70e5369876ea5e9120960376a
data/README.md CHANGED
@@ -1,69 +1,113 @@
1
1
  # jekyll-theme-dusk
2
-
3
2
  This theme was built for GitHub Pages.
4
3
 
4
+ ### WARNING
5
+ This theme assumes that your images are stored at
6
+ ````
7
+ /assets/images
8
+ ````
9
+ It's good practice to put your assets in an assets folder, in my opinion at least.
10
+
5
11
  ## Installation
6
12
 
7
13
  Add this line to your Jekyll site's `Gemfile`:
8
-
9
- ```ruby
14
+ ```
15
+ ruby
10
16
  gem "jekyll-theme-dusk"
11
17
  ```
12
-
13
18
  And add this line to your Jekyll site's `_config.yml`:
14
-
15
- ```yaml
19
+ ```
20
+ yaml
16
21
  theme: jekyll-theme-dusk
17
22
  ```
18
-
19
23
  And then execute:
20
-
24
+ ```
21
25
  $ bundle
22
-
26
+ ```
23
27
  Or install it yourself as:
24
-
28
+ ```
25
29
  $ gem install jekyll-theme-dusk
26
-
30
+ ```
27
31
  ## Usage
28
32
 
29
33
  This theme has many features in it. They are written here so that it is easier to use them.
30
34
 
31
35
  - ### Navigation Menu
32
-
33
- To edit entries in the navigation menu, edit;
34
- ```
35
- _data/navigation.yml
36
- ```
37
- and add your pages, and icons if you want them.
38
- Here is an example:
39
- ```
40
- - name: Home
41
- icon:
42
- link: /
43
- - name: About
44
- icon: /assets/images/about-icon.png
45
- link: /about.html
46
- - name: Blog
47
- icon: /assets/images/blog-icon.png
48
- link: /blog.html
49
- ```
50
- ![Editing the navigation menu, as a GIF](.readme/edit-nav.gif "Edit the navigation menu")
51
- Crunchy gif :)
52
-
53
- - ### Home Page
54
-
55
- To edit the home page, you need to include a title for the page, and a small summary.
56
- This can be found in the front matter. Here is an example.
57
- ```
58
- layout: home
59
- permalink: /
60
- title: "Dusk"
61
- summary: "Dusk is a theme built for GitHub Pages."
62
- ```
36
+ To edit entries in the navigation menu, edit;
37
+ ```
38
+ _data/navigation.yml
39
+ ```
40
+ and add your pages, and icons if you want them.
41
+ Here is an example:
42
+ ```
43
+ yaml
44
+ - name: Home
45
+ icon:
46
+ link: /
47
+ - name: About
48
+ icon: /assets/images/about-icon.png
49
+ link: /about.html
50
+ - name: Blog
51
+ icon: /assets/images/blog-icon.png
52
+ link: /blog.html
53
+ ```
54
+ ![Editing the navigation menu, as a GIF](.readme/edit-nav.gif "Edit the navigation menu")
55
+ Crunchy gif :)
56
+
57
+ - ### Image Galleries
58
+
59
+ *This one is a bit complicated, but is pretty cool in my opinion.*
60
+ If you want to create a gallery, you will need to do a few things.
61
+
62
+ **In this section, replace [GALLERY_NAME] with the name of a gallery. This must be the same for all parts if you want to use the gallery without issues.**
63
+
64
+ 1. Create the folders at the paths:
65
+ ```
66
+ /assets/images/gallery/
67
+
68
+ /assets/images/gallery/[GALLERY_NAME]/
69
+
70
+ /data/galleries/
71
+ ```
72
+ 2. Place your images at ```/assets/images/gallery/[GALLERY_NAME]/(your images)```
73
+ Replace ```(your images)``` with *your images*. What did you expect?
74
+
75
+ 3. Place a file at ```_data/galleries``` called ```[GALLERY_NAME].yml``` and add the names of your images according to the example below:
76
+ ```
77
+ yaml
78
+ - image: tux.jpg
79
+ - image: tux-flag.jpg
80
+ - image: tux-old.jpg
81
+ - image: tux-trollface.jpg
82
+ - image: tux-unfaithful.jpg
83
+ ```
84
+
85
+ 4. Place the following code into anywhere you want to add an image gallery:
86
+ ```
87
+ liquid
88
+ {%- include image-gallery.html gallery_id="[GALLERY_NAME]" -%}
89
+ ```
90
+
91
+ 5. Enjoy your images!
92
+
93
+ ![Example of image gallery feature](.readme/image-gallery.png "Example of image gallery feature")
94
+ Located at ```_posts/2023-04-21-hello-world.md```
95
+
96
+ - ### Home Page
97
+
98
+ To edit the home page, you need to include a title for the page, and a small summary.
99
+ This can be found in the front matter. Here is an example.
100
+ ```
101
+ yaml
102
+ layout: home
103
+ permalink: /
104
+ title: "Dusk"
105
+ summary: "Dusk is a theme built for GitHub Pages."
106
+ ```
63
107
 
64
108
  - ### Blog Page
65
109
 
66
- This page contains all your posts that you have made on your website. All you need to do is just to make some posts, and then they will all appear there.
110
+ This page contains all your posts that you have made on your website. All you need to do is just to make some posts, and then they will all appear there.
67
111
 
68
112
  ## Contributing
69
113
 
data/_includes/image-gallery.html CHANGED
@@ -1,6 +1,6 @@
1
1
  <!-- credit to Tim Van Damme at css-tricks.com -->
2
2
  <!-- https://css-tricks.com/adaptive-photo-layout-with-flexbox -->
3
- <div id="image-gallery">
3
+ <div class="image-gallery">
4
4
  <ul>
5
5
  {%- for item in site.data.galleries[include.gallery_id] -%}
6
6
  <li>
data/_sass/base.scss CHANGED
@@ -80,33 +80,31 @@ hr {
80
80
 
81
81
  article {
82
82
  margin: 20px 0;
83
+ }
83
84
 
84
- #image-gallery {
85
- background-color: green;
86
-
87
- ul {
88
- display: flex;
89
- flex-wrap: wrap;
90
- list-style: none;
91
- padding-left: 0;
92
-
93
- &:after {
94
- content:'';
95
- display:block;
96
- flex-grow: 10;
97
- }
98
- }
99
-
100
- li {
101
- height: 40vh;
102
- flex-grow: 1;
103
- }
104
-
105
- img {
106
- max-height: 100%;
107
- min-width: 100%;
108
- object-fit: cover;
109
- vertical-align: bottom;
85
+ .image-gallery {
86
+ ul {
87
+ display: flex;
88
+ flex-wrap: wrap;
89
+ list-style: none;
90
+ padding-left: 0;
91
+
92
+ &:after {
93
+ content:'';
94
+ display:block;
95
+ flex-grow: 10;
110
96
  }
111
97
  }
98
+
99
+ li {
100
+ height: 40vh;
101
+ flex-grow: 1;
102
+ }
103
+
104
+ img {
105
+ max-height: 100%;
106
+ min-width: 100%;
107
+ object-fit: cover;
108
+ vertical-align: bottom;
109
+ }
112
110
  }
data/_sass/include.scss CHANGED
@@ -101,7 +101,6 @@ header {
101
101
  transition: 0.5s;
102
102
 
103
103
  text-align: center;
104
- /* debug */
105
104
  background-color: rgba(0, 0, 0, 0.6);
106
105
 
107
106
  a {
@@ -127,6 +126,7 @@ header {
127
126
  }
128
127
 
129
128
  #open-nav {
129
+ background-color: rgba(0, 0, 0, 0.6);
130
130
  position: fixed;
131
131
  top: 7px;
132
132
  right: 7px;
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: jekyll-theme-dusk
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.5
4
+ version: 0.3.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Parmjot Singh
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-05-08 00:00:00.000000000 Z
11
+ date: 2023-05-09 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: github-pages