henry-jekyll 1.3.1 → 1.3.2

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: cb8882006faca3955357ea3ab9cf94590823320abdeeac2a00c7b982422dc4d8
4
- data.tar.gz: e17fbe458c5239109f21dd6fe29b2264b3ae8a312296b656b08f34c17f7f8562
3
+ metadata.gz: 90f6f133a69ea0f25ccf08a42b461f67ddcb6b66e786d5a8a42f04c7e51c7903
4
+ data.tar.gz: b8a93e2eac44fd3baf5d79267f5180eb2079f81dbff520fcaa3bf996423efac2
5
5
  SHA512:
6
- metadata.gz: abb90b2251d24f868203000c3813b5affd71eca49dbb430f52ed54f2e3a4b10bced32890d13315f95f43629bdc459f84762910d2575e25391f8743dc736d0382
7
- data.tar.gz: dbf22f51f53f888963e568661fe2447d6b1bf6986174d95429781a1ea5290e15c24fbbf50e3f016724606bfb2c7fe4af22c0eab4ead5333a5931fdd91b625014
6
+ metadata.gz: 89a76982a03a1b3b5c3a0d9622beb9f4f86fc5c84d83b936c61db6d06530b303f5fdf43e939ba293df6b805a0b06e78512465b9ae2d73f0a4c6a20b314d5d40d
7
+ data.tar.gz: bda755fa2bd92d55b01accdaf981c256934d11fcc303d6875771596b71c3cd2f540f7bc9bb77d5af2609fd4accb5ac6cea2402a8b62b5d84b1631ad9814e751a
data/README.md CHANGED
@@ -1,87 +1,57 @@
1
1
  # Henry
2
2
 
3
- Henry is a [Jekyll](https://jekyllrb.com/) theme with a gorgeous reading experience and packed with features.
3
+ <p align="center"><img src="assets/img/henry.png"></p>
4
4
 
5
- To find out more about all the features, check this intro [blog post](https://blog.jkl.gg/henry-jekyll-theme/).
5
+ Henry is a [Jekyll](https://github.com/jekyll/) theme with a gorgeous reading experience, chock-full of features. To find out more about all the features check out this [blog post](https://blog.jkl.gg/henry-jekyll-theme/).
6
6
 
7
- By simply adding henry to your jekyll blog setup, you can now use all the same features there!
7
+ # Getting Started
8
8
 
9
- 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`.
9
+ The easiest way to get up and running with a Jekyll blog using Henry is using the included [Docker](https://www.docker.com/) configuration file.
10
10
 
11
- To experiment with this code, add some sample content and run `bundle exec jekyll serve` – this directory is setup just like a Jekyll site!
12
-
13
- ## Installation
14
-
15
- Add this line to your Jekyll site's `Gemfile`:
16
-
17
- ```ruby
18
- gem "henry-jekyll"
11
+ ```shell
12
+ # 1. clone Henry
13
+ git clone git@github.com:kaushikgopal/henry-jekyll.git my_blog
14
+ # 2. cleanup script so unnecessary files are remoed
15
+ ./start_new_blog.sh
16
+ # 3. spin up blog with docker
17
+ docker-compose up
19
18
  ```
20
19
 
21
- And add this line to your Jekyll site's `_config.yml`:
20
+ You're good to go!
22
21
 
23
- ```yaml
24
- theme: henry-jekyll
22
+ ```shell
23
+ ## on a Mac
24
+ http://0.0.0.0:4000/
25
+ ## on Windows
26
+ http://localhost:4000/
25
27
  ```
26
28
 
27
- And then execute:
28
-
29
- $ bundle
30
-
31
- Or install it yourself as:
29
+ You can setup new/existing blogs with Henry, with or without Docker. Feel free to refer to this [setup guide](./setup.md) for details.
32
30
 
33
- $ gem install henry-jekyll
31
+ # Publishing guide
34
32
 
35
- ## Usage
33
+ ## Github Pages
36
34
 
37
- ## How to override styles
35
+ If you wish to publish your blog using [Github Pages](https://pages.github.com) (a popular free hosting option) you can follow this [publishing guide](./publishing_github_pages.md).
38
36
 
39
- The theme should all just work but if you want to add a little flair and differentiate yourself from other sites/blogs you can do so by adding a few overrides `.scss` files to your `_sass/` directory:
40
-
41
- 1. `./assets/css/style.scss`
42
- 2. `./assets/theme_override.scss`
43
- 3. `./assets/main_override.scss`
44
-
45
- Henry by default loads `_initialize.scss`, so we'll need to override that file like so:
46
-
47
- ```scss
48
- // inside ./assets/css/style.scss
49
- @import "theme", "theme_override";
50
- @import "mixins", "code", "base";
51
- @import "main", "main_override";
52
- ```
37
+ ## Firebase Hosting (included with Docker container)
53
38
 
54
- You can now override Henry's style by updating two of those override files.
39
+ Another good option to publish your blog is [Firebase hosting](https://firebase.google.com/docs/hosting). It includes a pretty generous free plan and allows plenty of customizability. Here's a [setup guide](./publishing_firebase_hosting.md).
55
40
 
56
- ```scss
57
- // inside ./_sass/theme_override.scss
58
- // change font sizes, styles, colors in here
41
+ # Contributing
59
42
 
60
- $font-size-regular: 30px;
61
- $background-color: black;
62
- $color-text: red;
63
-
64
- // take a look at the main `theme.scss` file to see the full list of variables you can customize
65
- ```
66
-
67
- To actually change specific styles, make sure to put them in the main override. The order of imports matter.
68
-
69
- ```scss
70
- // inside ./_sass/main.scss
71
- // change layout or site styles here
43
+ Bug reports and pull requests are welcome on [GitHub](https://github.com/kaushikgopal/henry-jekyll). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
72
44
 
73
- ul.post-list-content .post-link a.post-link-url {
74
- color: red
75
- }
45
+ To get started check out the [DEVELOPMENT](https://github.com/kaushikgopal/henry-jekyll/blob/main/DEVELOPMENT.md) page.
76
46
 
77
- // take a look at the main `main.scss` file to see the current layout styles
78
- ```
47
+ # Henry in the Wild
79
48
 
80
- ## Contributing
49
+ Here are a couple of blogs that use Henry:
81
50
 
82
- Bug reports and pull requests are welcome on [GitHub](https://github.com/kaushikgopal/henry-jekyll). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
51
+ 1. [Karthick Gopal's blog](https://blog.karthickg.com)
52
+ 2. [Kaushik Gopal's blog](https://blog.jkl.gg)
53
+ 3. [Nic Finn's blog](https://neodymiumphi.sh) _(Github Pages)_
83
54
 
84
- ## License
55
+ # License
85
56
 
86
57
  The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
87
-
data/_config.yml CHANGED
@@ -1,3 +1,17 @@
1
+ # Welcome to Jekyll!
2
+ #
3
+ # This config file is meant for settings that affect your whole blog, values
4
+ # which you are expected to set up once and rarely edit after that. If you find
5
+ # yourself editing this file very often, consider using Jekyll's data files
6
+ # feature for the data you need to update frequently.
7
+ #
8
+ # For technical reasons, this file is *NOT* reloaded automatically when you use
9
+ # 'bundle exec jekyll serve'. If you change this file, please restart the server process.
10
+ #
11
+ # If you need help with YAML syntax, here are some quick references for you:
12
+ # https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml
13
+ # https://learnxinyminutes.com/docs/yaml/
14
+
1
15
  # Docker for OSX uses a VM so we need 0.0.0.0 instead of 127.0.0.1
2
16
  host: 0.0.0.0
3
17
 
@@ -6,23 +20,33 @@ host: 0.0.0.0
6
20
  # you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
7
21
  # You can create any custom variable you would like, and they will be accessible
8
22
  # in the templates via {{ site.myvariable }}.
9
- title: Kaushik Gopal's Blog
23
+
24
+ title: Kaushik's new blog
10
25
  author:
11
26
  name: "Kaushik Gopal"
12
27
  twitter: kaushikgopal
13
28
  bio-url: "https://jkl.gg"
14
-
15
- external-url-indicator: " »"
16
-
17
- # Link settings
29
+ description: >- # this means to ignore newlines until "baseurl:"
30
+ Write an awesome description for your new site here. You can edit this
31
+ line in _config.yml. It will appear in your document head meta (for
32
+ Google search results) and in your feed.xml site description.
33
+ baseurl: "" # the subpath of your site, e.g. /blog
34
+ url: "" # the base hostname & protocol for your site, e.g. http://example.com
18
35
  root: /
19
36
  permalink: /:title/
37
+ external-url-indicator: " »"
20
38
 
21
39
  # Build settings
40
+ theme: henry-jekyll
22
41
  markdown: kramdown
23
42
  highlighter: rouge
24
43
  encoding: utf-8
25
44
 
45
+ # Jekyll Plugins (only needed for GitHub Pages)
46
+ plugins:
47
+ - jekyll-feed
48
+ - jekyll-seo-tag
49
+
26
50
  # front matter defaults https://jekyllrb.com/docs/configuration/front-matter-defaults/
27
51
  defaults:
28
52
  - scope:
@@ -32,15 +56,25 @@ defaults:
32
56
  layout: "post"
33
57
 
34
58
  # Exclude from processing.
35
- # The following items will not be processed, by default. Create a custom list
36
- # to override the default setting.
59
+ # The following items will not be processed, by default.
60
+ # Any item listed under the `exclude:` key here will be automatically added to
61
+ # the internal "default list".
62
+ #
63
+ # Excluded items can be processed by explicitly listing the directories or
64
+ # their entries' file path in the `include:` list.
65
+
37
66
  exclude:
38
- - docker-compose-publish.yml
39
- - docker-compose.yml
40
- - firebase.json
41
- - .idea/
42
- # - Gemfile
43
- # - Gemfile.lock
67
+ - .idea/
68
+ - DEVELOPMENT.md
69
+ - Gemfile
70
+ - Gemfile.lock
71
+ - README.md
72
+ - docker-compose-publish.yml
73
+ - docker-compose.yml
74
+ - firebase.json
75
+ - henry-jekyll.gemspec
76
+ - publishing_firebase_hosting.md
77
+ - publishing_github_pages.md
44
78
  # - node_modules
45
79
  # - vendor/bundle/
46
80
  # - vendor/cache/
File without changes
data/_sass/main.scss CHANGED
@@ -15,13 +15,21 @@
15
15
  }
16
16
  }
17
17
 
18
+
18
19
  .post .full-bleed {
19
- width: 100vw;
20
+ // correct to match exact 100vw
21
+ width: calc(
22
+ 100vw
23
+ - 2 * #{$spacing-micro-unit}
24
+ - 1.5px
25
+ );
20
26
 
27
+ /*
28
+ .post-content margin
29
+ */
21
30
  margin-left: calc(
22
- (100vw - #{"min(65ch, 100vw)"})
23
- * (.2 / 1.2)
24
- * (-1)
31
+ (-1)
32
+ * (100vw - #{"min(65ch, 100vw)"}) * (.2/1.2)
25
33
  - #{$spacing-unit}
26
34
  );
27
35
  }
@@ -424,6 +432,13 @@ ul.callout {
424
432
  padding: 1em 0;
425
433
  }
426
434
 
435
+ a.footnote {
436
+ text-decoration: none;
437
+ &:hover {
438
+ color: $color-link;
439
+ }
440
+ }
441
+
427
442
  /* Code snippets
428
443
  ================================================== */
429
444
  code {
Binary file
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: henry-jekyll
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.3.1
4
+ version: 1.3.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Kaushik Gopal
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-03-10 00:00:00.000000000 Z
11
+ date: 2021-05-31 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: jekyll
@@ -147,13 +147,14 @@ files:
147
147
  - _layouts/raw.html
148
148
  - _sass/_initialize.scss
149
149
  - _sass/base.scss
150
- - _sass/code.css
150
+ - _sass/code.scss
151
151
  - _sass/main.scss
152
152
  - _sass/main_override.scss
153
153
  - _sass/mixins.scss
154
154
  - _sass/theme.scss
155
155
  - _sass/theme_override.scss
156
156
  - assets/css/style.scss
157
+ - assets/img/henry.png
157
158
  - assets/js/jquery.min.js
158
159
  - assets/js/sidenotes.js
159
160
  homepage: https://blog.jkl.gg/henry-jekyll-theme/