henry-jekyll 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb8882006faca3955357ea3ab9cf94590823320abdeeac2a00c7b982422dc4d8
-  data.tar.gz: e17fbe458c5239109f21dd6fe29b2264b3ae8a312296b656b08f34c17f7f8562
+  metadata.gz: 90f6f133a69ea0f25ccf08a42b461f67ddcb6b66e786d5a8a42f04c7e51c7903
+  data.tar.gz: b8a93e2eac44fd3baf5d79267f5180eb2079f81dbff520fcaa3bf996423efac2
 SHA512:
-  metadata.gz: abb90b2251d24f868203000c3813b5affd71eca49dbb430f52ed54f2e3a4b10bced32890d13315f95f43629bdc459f84762910d2575e25391f8743dc736d0382
-  data.tar.gz: dbf22f51f53f888963e568661fe2447d6b1bf6986174d95429781a1ea5290e15c24fbbf50e3f016724606bfb2c7fe4af22c0eab4ead5333a5931fdd91b625014
+  metadata.gz: 89a76982a03a1b3b5c3a0d9622beb9f4f86fc5c84d83b936c61db6d06530b303f5fdf43e939ba293df6b805a0b06e78512465b9ae2d73f0a4c6a20b314d5d40d
+  data.tar.gz: bda755fa2bd92d55b01accdaf981c256934d11fcc303d6875771596b71c3cd2f540f7bc9bb77d5af2609fd4accb5ac6cea2402a8b62b5d84b1631ad9814e751a

data/README.md

@@ -1,87 +1,57 @@
 # Henry
 
-Henry is a [Jekyll](https://jekyllrb.com/) theme with a gorgeous reading experience and packed with features. 
+<p align="center"><img src="assets/img/henry.png"></p>
 
-To find out more about all the features, check this intro [blog post](https://blog.jkl.gg/henry-jekyll-theme/).
+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/).
 
-By simply adding henry to your jekyll blog setup, you can now use all the same features there! 
+# Getting Started
 
-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`.
+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.
 
-To experiment with this code, add some sample content and run `bundle exec jekyll serve` – this directory is setup just like a Jekyll site!
-
-## Installation
-
-Add this line to your Jekyll site's `Gemfile`:
-
-```ruby
-gem "henry-jekyll"
+```shell
+# 1. clone Henry
+git clone git@github.com:kaushikgopal/henry-jekyll.git my_blog
+# 2. cleanup script so unnecessary files are remoed
+./start_new_blog.sh
+# 3. spin up blog with docker
+docker-compose up
 ```
 
-And add this line to your Jekyll site's `_config.yml`:
+You're good to go!
 
-```yaml
-theme: henry-jekyll
+```shell
+## on a Mac
+http://0.0.0.0:4000/
+## on Windows
+http://localhost:4000/
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
+You can setup new/existing blogs with Henry, with or without Docker. Feel free to refer to this [setup guide](./setup.md) for details.
 
-    $ gem install henry-jekyll
+# Publishing guide
 
-## Usage
+## Github Pages
 
-## How to override styles
+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).
 
-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:
-
-1. `./assets/css/style.scss`
-2. `./assets/theme_override.scss`
-3. `./assets/main_override.scss`
-
-Henry by default loads `_initialize.scss`, so we'll need to override that file like so: 
-
-```scss
-// inside ./assets/css/style.scss
-@import "theme", "theme_override";
-@import "mixins", "code", "base";
-@import "main", "main_override";
-```
+## Firebase Hosting (included with Docker container)
 
-You can now override Henry's style by updating two of those override files.
+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).
 
-```scss
-// inside ./_sass/theme_override.scss
-// change font sizes, styles, colors in here
+# Contributing
 
-$font-size-regular:     30px;
-$background-color:      black;
-$color-text:            red;
-
-// take a look at the main `theme.scss` file to see the full list of variables you can customize
-```
-
-To actually change specific styles, make sure to put them in the main override. The order of imports matter.
-
-```scss
-// inside ./_sass/main.scss
-// change layout or site styles here
+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.
 
-ul.post-list-content .post-link a.post-link-url {
-    color: red
-}
+To get started check out the [DEVELOPMENT](https://github.com/kaushikgopal/henry-jekyll/blob/main/DEVELOPMENT.md) page.
 
-// take a look at the main `main.scss` file to see the current layout styles
-```
+# Henry in the Wild
 
-## Contributing
+Here are a couple of blogs that use Henry:
 
-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.
+1. [Karthick Gopal's blog](https://blog.karthickg.com)
+2. [Kaushik Gopal's blog](https://blog.jkl.gg)
+3. [Nic Finn's blog](https://neodymiumphi.sh) _(Github Pages)_
 
-## License
+# License
 
 The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-

data/_config.yml

@@ -1,3 +1,17 @@
+# Welcome to Jekyll!
+#
+# This config file is meant for settings that affect your whole blog, values
+# which you are expected to set up once and rarely edit after that. If you find
+# yourself editing this file very often, consider using Jekyll's data files
+# feature for the data you need to update frequently.
+#
+# For technical reasons, this file is *NOT* reloaded automatically when you use
+# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
+#
+# If you need help with YAML syntax, here are some quick references for you:
+# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml
+# https://learnxinyminutes.com/docs/yaml/
+
 # Docker for OSX uses a VM so we need 0.0.0.0 instead of 127.0.0.1
 host: 0.0.0.0
 
@@ -6,23 +20,33 @@ host: 0.0.0.0
 # you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
 # You can create any custom variable you would like, and they will be accessible
 # in the templates via {{ site.myvariable }}.
-title: Kaushik Gopal's Blog
+
+title: Kaushik's new blog
 author:
   name: "Kaushik Gopal"
   twitter: kaushikgopal
   bio-url: "https://jkl.gg"
-
-external-url-indicator: " »"
-
-# Link settings
+description: >- # this means to ignore newlines until "baseurl:"
+  Write an awesome description for your new site here. You can edit this
+  line in _config.yml. It will appear in your document head meta (for
+  Google search results) and in your feed.xml site description.
+baseurl: "" # the subpath of your site, e.g. /blog
+url: "" # the base hostname & protocol for your site, e.g. http://example.com
 root: /
 permalink: /:title/
+external-url-indicator: " »"
 
 # Build settings
+theme: henry-jekyll
 markdown: kramdown
 highlighter: rouge
 encoding: utf-8
 
+# Jekyll Plugins (only needed for GitHub Pages)
+plugins:
+  - jekyll-feed
+  - jekyll-seo-tag
+
 # front matter defaults https://jekyllrb.com/docs/configuration/front-matter-defaults/
 defaults:
   - scope:
@@ -32,15 +56,25 @@ defaults:
       layout: "post"
 
 # Exclude from processing.
-# The following items will not be processed, by default. Create a custom list
-# to override the default setting.
+# The following items will not be processed, by default.
+# Any item listed under the `exclude:` key here will be automatically added to
+# the internal "default list".
+#
+# Excluded items can be processed by explicitly listing the directories or
+# their entries' file path in the `include:` list.
+
 exclude:
-  - docker-compose-publish.yml
-  - docker-compose.yml
-  - firebase.json
-  - .idea/
-#   - Gemfile
-#   - Gemfile.lock
+ - .idea/
+ - DEVELOPMENT.md
+ - Gemfile
+ - Gemfile.lock
+ - README.md
+ - docker-compose-publish.yml
+ - docker-compose.yml
+ - firebase.json
+ - henry-jekyll.gemspec
+ - publishing_firebase_hosting.md
+ - publishing_github_pages.md
 #   - node_modules
 #   - vendor/bundle/
 #   - vendor/cache/

data/_sass/main.scss

@@ -15,13 +15,21 @@
     }
 }
 
+
 .post .full-bleed {
-    width: 100vw;
+    // correct to match exact 100vw
+    width: calc(
+            100vw
+            - 2 * #{$spacing-micro-unit}
+            - 1.5px
+    );
 
+    /*
+    .post-content margin
+    */
     margin-left: calc(
-            (100vw - #{"min(65ch, 100vw)"})
-            * (.2 / 1.2)
-            * (-1)
+            (-1)
+            * (100vw - #{"min(65ch, 100vw)"}) * (.2/1.2)
             - #{$spacing-unit}
     );
 }
@@ -424,6 +432,13 @@ ul.callout {
     padding: 1em 0;
 }
 
+a.footnote {
+    text-decoration: none;
+    &:hover {
+        color: $color-link;
+    }
+}
+
 /* Code snippets
 ================================================== */
 code {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: henry-jekyll
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Kaushik Gopal
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-10 00:00:00.000000000 Z
+date: 2021-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -147,13 +147,14 @@ files:
 - _layouts/raw.html
 - _sass/_initialize.scss
 - _sass/base.scss
-- _sass/code.css
+- _sass/code.scss
 - _sass/main.scss
 - _sass/main_override.scss
 - _sass/mixins.scss
 - _sass/theme.scss
 - _sass/theme_override.scss
 - assets/css/style.scss
+- assets/img/henry.png
 - assets/js/jquery.min.js
 - assets/js/sidenotes.js
 homepage: https://blog.jkl.gg/henry-jekyll-theme/