Skip to content

[pull] master from fongandrew:master #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pull wants to merge 8 commits into
base: master
Choose a base branch
from
Open

[pull] master from fongandrew:master #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
86075d2
Update version, Jekyll requirements
fongandrew Apr 14, 2025
acea905
gh-pages github action
fongandrew Apr 14, 2025
e8cca67
Newer bundler
fongandrew Apr 14, 2025
d90a976
Update build and deploy
fongandrew Apr 14, 2025
8c2fa00
Revert to 265598d905fea02a55815ecce02c0d40ae9c13cc while preserving h…
fongandrew Apr 14, 2025
a66ef05
Build jekyll-v4 but put workflow on main
fongandrew Apr 14, 2025
cbf10e8
Permissions?
fongandrew Apr 14, 2025
05ecba2
Jekyll 3.x / 4.x usage details
fongandrew Apr 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions .github/workflows/jekyll-build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Build Jekyll Site

on:
push:
branches: [jekyll-v4]

permissions:
contents: read
pages: write
id-token: write

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Setup Ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: '3.2'
bundler: '2.6.8'
bundler-cache: true

- name: Build Jekyll site
run: |
bundle install
bundle exec jekyll build

- name: Upload artifact
uses: actions/upload-pages-artifact@v3

deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
2 changes: 1 addition & 1 deletion Gemfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
source "https://rubygems.org"
gemspec
gemspec
2 changes: 1 addition & 1 deletion LICENSE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Copyright (c) 2013 Mark Otto.

Copyright (c) 2017 Andrew Fong and additional contributors (https://github.com/fongandrew/hydeout/graphs/contributors)
Copyright (c) 2017 Andrew Fong.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

Expand Down
57 changes: 26 additions & 31 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,28 @@ theme for [Jekyll](http://jekyllrb.com) 3.x and 4.x and adds new functionality.
<img alt="Mobile home page" src="/_screenshots/2.png?raw=true" width="300px" />
<img alt="Mobile post page" src="/_screenshots/3.png?raw=true" width="300px" />

### Usage
## ⚠️ IMPORTANT: Branch Information ⚠️

Hydeout is available as the `jekyll-theme-hydeout` Ruby Gem.
Add `gem "jekyll-theme-hydeout", "~> 4.1"` to your Gemfile and run
`bundle install`.
### 👉 For Jekyll 4.x Users (Recommended for New Projects)

If you're installing on Github pages, you may also have to add
`remote_theme: fongandrew/hydeout` to your `_config.yml`. [See the Github
instructions for more details.](https://help.github.com/articles/adding-a-jekyll-theme-to-your-github-pages-site/)
**Use the [jekyll-v4 branch](https://github.com/fongandrew/hydeout/tree/jekyll-v4) for all new projects.**

The jekyll-v4 branch is actively maintained (well, at least more maintained than this branch) and includes full support for Jekyll 4.x with improvements and bug fixes.

```bash
# Clone with jekyll-v4 branch (recommended)
git clone -b jekyll-v4 https://github.com/fongandrew/hydeout.git
```

### Current Branch: Jekyll 3.x Support (master)

**You're currently viewing the README for the legacy Jekyll 3.x version (master branch).**

This master branch is maintained for legacy support and compatibility with older GitHub Pages deployments. It will remain on Jekyll 3.x for as long as [GitHub Pages continues to support this version](https://pages.github.com/versions/).

The master branch exists primarily to avoid breaking existing GitHub Pages sites that use `remote_theme: fongandrew/hydeout` in their `_config.yml` files (see usage below). [See the GitHub instructions for more details.](https://help.github.com/articles/adding-a-jekyll-theme-to-your-github-pages-site/).

## Usage details

Hydeout uses pagination, so if you have an `index.md`, you'll need to swap
it with an `index.html` that uses the `index` layout:
Expand Down Expand Up @@ -53,41 +66,23 @@ $layout-reverse: false !default;
$link-color: #268bd2 !default;
```

To override these variables, define your own variables inside a SASS file
in the `assets/css/` directory.
Then `@use` that file in your own `assets/css/main.scss` file, like so:
To override these variables, create your own `assets/css/main.scss` file.
Define your own variables, then import in Hydeout's SCSS, like so:

```scss
---
# Jekyll needs front matter for SCSS files
---

@use "colours";
@use "hydeout/variables" with (
$body-bg: colours.$grey,
$body-color: white,
$heading-color: colours.$light-pink,
$link-color: colours.$green,
$sidebar-bg-color: colours.$dark-pink,
$sidebar-sticky: false,
);
@use "hydeout";
```

Example content of `assets/css/colours.scss`:

```scss
$green: #61c200;
$grey: #363636;
$dark-pink: #9f0647;
$light-pink: #f0a2c3;
$sidebar-bg-color: #ac4142;
$link-color: #ac4142;
$sidebar-sticky: false;
@import "hydeout";
```

See the [_variables](_sass/hydeout/_variables.scss) file for other variables
you can override.

**Pay attention to the namespace of the variables you intend to override, otherwise, you will probably experience errors.**

You can see the full set of partials you can replace in the
[`_includes`](_includes) folder, but there are a few worth noting:

Expand Down
30 changes: 0 additions & 30 deletions _config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,40 +26,10 @@ plugins:
- jekyll-feed
- jekyll-gist
- jekyll-paginate
- jekyll-include-cache
- jemoji

exclude:
- Gemfile
- Gemfile.lock
- Makefile
- README.md
- .gitignore

permalink: /:year/:month/:day/:title.html

defaults:
- scope:
path: "_posts"
type: "posts"
values:
excerpt_separator: <!--more-->
layout: post

# Sidebar link settings
sidebar_home_link: true
# sidebar_blog_link: '/blog' # By default, your home page is your blog
# page. If you change your paginate_path,
# set this to the root of the paginate_path
# to enable a separate blog link.

disqus:
shortname: hydeout

google_analytics: UA-100461102-1

# Used for Hydeout's own Github page. Feel free to remove for your
# own fork.
hydeout:
version: 4.2.0
repo: https://github.com/fongandrew/hydeout
6 changes: 1 addition & 5 deletions _includes/back-link.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
{% if page.back_page %}

{% assign back_page = site.pages | where: "name", page.back_page | first %}
{% assign back_page = site.pages | find: "name", page.back_page %}
{% if back_page != null %}
<p class="back-link">
<a href="{{ back_page.url | relative_url }}"><span class="back-arrow icon">{% include svg/back-arrow.svg %}</span>{{ back_page.short_title | default: back_page.title }}</a>
</p>
{% endif %}

{% endif %}
14 changes: 14 additions & 0 deletions _posts/2010-10-25-post-future-date.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
layout: post
title: "Post: Future Date"
date: 9999-12-31
categories:
- Post
last_modified_at: 2017-03-09T12:45:25-05:00
---

This post lives in the future and is dated {{ page.date | date: "%c" }}. It should only appear when Jekyll builds your project with the `--future` flag.

```bash
jekyll build --future
```
2 changes: 1 addition & 1 deletion _posts/2017-06-01-hello-hydeout.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Define your own variables, then import in Hydeout's SCSS, like so:
$sidebar-bg-color: #ac4142;
$link-color: #ac4142;
$sidebar-sticky: false;
@use "hydeout";
@import "hydeout";
```

See the [_variables](https://github.com/fongandrew/hydeout/blob/master/_sass/hydeout/_variables.scss) file for other variables
Expand Down
26 changes: 13 additions & 13 deletions _sass/hydeout.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@
Designed, built, and released under MIT license by @mdo.
*/

@use 'hydeout/variables';
@use 'hydeout/base';
@use 'hydeout/type';
@use 'hydeout/syntax';
@use 'hydeout/code';
@use 'hydeout/layout';
@use 'hydeout/masthead';
@use 'hydeout/posts';
@use 'hydeout/pagination';
@use 'hydeout/message';
@use 'hydeout/search';
@use 'hydeout/tags';
@use 'hydeout/back-link';
@import 'hydeout/variables';
@import 'hydeout/base';
@import 'hydeout/type';
@import 'hydeout/syntax';
@import 'hydeout/code';
@import 'hydeout/layout';
@import 'hydeout/masthead';
@import 'hydeout/posts';
@import 'hydeout/pagination';
@import 'hydeout/message';
@import 'hydeout/search';
@import 'hydeout/tags';
@import 'hydeout/back-link';
43 changes: 18 additions & 25 deletions _sass/hydeout/_base.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
@use "variables";

// Body resets
//
// Update the foundational and global aspects of the page.
Expand All @@ -15,12 +13,12 @@ body {
}

html {
font-family: variables.$root-font-family;
font-size: variables.$root-font-size;
line-height: variables.$root-line-height;
font-family: $root-font-family;
font-size: $root-font-size;
line-height: $root-line-height;

@media (min-width: variables.$large-breakpoint) {
font-size: variables.$large-font-size;
@media (min-width: $large-breakpoint) {
font-size: $large-font-size;
}
}

Expand All @@ -36,7 +34,7 @@ section {

// No `:visited` state is required by default (browsers will use `a`)
a {
color: variables.$link-color;
color: $link-color;
text-decoration: none;

// `:focus` is linked to `:hover` for basic accessibility
Expand All @@ -59,7 +57,7 @@ img {
}

table {
border: 1px solid variables.$border-color;
border: 1px solid $border-color;
border-collapse: collapse;
font-size: 85%;
margin-bottom: 1rem;
Expand All @@ -68,7 +66,7 @@ table {

td,
th {
border: 1px solid variables.$border-color;
border: 1px solid $border-color;
padding: 0.25rem 0.5rem;
}

Expand All @@ -78,34 +76,34 @@ th {

tbody tr:nth-child(odd) td,
tbody tr:nth-child(odd) th {
background-color: variables.$gray-1;
background-color: $gray-1;
}

button,
input[type='text'],
input[type='email'],
input[type='search'],
input[type='submit'] {
border: 1px solid variables.$border-color;
border-radius: variables.$border-radius;
padding: variables.$padding-v variables.$padding-h;
border: 1px solid $border-color;
border-radius: $border-radius;
padding: $padding-v $padding-h;
}

button,
input[type='submit'] {
background: transparent;
border-color: variables.$border-color;
color: variables.$link-color;
border-color: $border-color;
color: $link-color;
cursor: pointer;
transition:
color 0.6s ease-in-out,
border-color 0.6s ease-in-out,
background 0.6s ease-in-out;

&:hover {
background: variables.$link-color;
border-color: variables.$link-color;
box-shadow: variables.$default-box-shadow;
background: $link-color;
border-color: $link-color;
box-shadow: $default-box-shadow;
color: #fff;
}
}
Expand All @@ -128,9 +126,4 @@ input[type='submit'] {
left: 0;
width: 100%;
height: 100%;
}

.emoji {
display: initial;
margin: initial;
}
}
6 changes: 2 additions & 4 deletions _sass/hydeout/_code.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,17 @@
@use "variables";

// Code
//
// Inline and block-level code snippets. Includes tweaks to syntax highlighted
// snippets from Pygments/Rouge and Gist embeds.

code,
pre {
font-family: variables.$code-font-family;
font-family: $code-font-family;
}

code {
background-color: #f9f9f9;
border-radius: 3px;
color: variables.$code-color;
color: $code-color;
font-size: 85%;
padding: 0.25em 0.5em;
}
Expand Down
Loading