Skip to content
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.

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

Version 2.0 #2

Merged
merged 36 commits into from
Feb 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
ef5825c
Initial rewrite [WIP]
jotonedev Feb 23, 2024
b7138fa
Add cards to homepage
jotonedev Feb 24, 2024
2438784
Update gitignore
jotonedev Feb 24, 2024
33a417d
Add feed page
jotonedev Feb 25, 2024
cc0c0e7
Add build action
jotonedev Feb 25, 2024
b3a07e2
Update deps
jotonedev Feb 25, 2024
b74ccfe
Fix action
jotonedev Feb 25, 2024
ec6d220
Fix action #2
jotonedev Feb 25, 2024
5c8ee37
Rename actions
jotonedev Feb 25, 2024
b2344dd
Upgrade actions
jotonedev Feb 25, 2024
c7f8842
Fix mobile view
jotonedev Feb 25, 2024
5cd7ed2
Update readme
jotonedev Feb 26, 2024
7352071
Update README.md
jotonedev Feb 26, 2024
e6cad7f
Remove projects
jotonedev Feb 26, 2024
58ecaee
Change font
jotonedev Feb 27, 2024
e1d523f
Update README.md
jotonedev Feb 27, 2024
4ef6401
Import font into theme
jotonedev Feb 27, 2024
d7f21c0
Fix font
jotonedev Feb 27, 2024
fe58f7e
Update font.scss
jotonedev Feb 27, 2024
043d8bb
Update font.scss
jotonedev Feb 27, 2024
f21b2c4
Fix stray end tag
jotonedev Feb 27, 2024
8512c16
Replace section with div
jotonedev Feb 27, 2024
5160664
Add footer pages
jotonedev Feb 27, 2024
8ef60f6
Fix underline
jotonedev Feb 27, 2024
702b27b
Fix padding
jotonedev Feb 27, 2024
cfeaef9
Fix header moving between page change
jotonedev Feb 27, 2024
6920052
Remove text justification
jotonedev Feb 27, 2024
13c6910
Move copyright notice
jotonedev Feb 28, 2024
5e64a9e
Fix font size
jotonedev Feb 28, 2024
17c654d
Fix sitemap and feed
jotonedev Feb 28, 2024
8e25b4e
Reformat css code
jotonedev Feb 28, 2024
a31a039
Add about page with icons
jotonedev Feb 28, 2024
20e3034
Improve about page and various optimizations
jotonedev Feb 29, 2024
91346c5
Fix quote on small screen
jotonedev Feb 29, 2024
e0d6168
Optimization for logo
jotonedev Feb 29, 2024
be3b5ed
Add manifest
jotonedev Feb 29, 2024
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
6 changes: 3 additions & 3 deletions .github/workflows/gem-push.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Ruby Gem
name: Gem publish

on:
push:
Expand All @@ -15,11 +15,11 @@ jobs:
packages: write

steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- name: Set up Ruby 3.2
# To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
# change this to (see https://github.com/ruby/setup-ruby#versioning):
uses: ruby/setup-ruby@v1.168.0
uses: ruby/setup-ruby@v1
with:
ruby-version: 3.2.2

Expand Down
25 changes: 25 additions & 0 deletions .github/workflows/test-build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Test build

on:
push:
workflow_dispatch:

jobs:
build:
name: Build
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
- name: Set up Ruby 3.2
# To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
# change this to (see https://github.com/ruby/setup-ruby#versioning):
uses: ruby/setup-ruby@v1
with:
ruby-version: 3.2.2

- name: Install dependencies
run: bundle install

- name: Build
run: bundle exec jekyll build -t --disable-disk-cache
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -60,4 +60,6 @@ _site/
.jekyll-cache/
.jekyll-metadata

# End of https://mrkandreev.name/snippets/gitignore-generator/#Ruby,Jekyll
*.pdn
.idea/
.vscode/
6 changes: 6 additions & 0 deletions 404.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
layout: 404
private: true
no_meta: true
sitemap: false
---
4 changes: 3 additions & 1 deletion Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,7 @@ gemspec
group :jekyll_plugins do
gem "jekyll-sitemap"
gem "jekyll-seo-tag"
gem "jekyll-toc"
gem 'jekyll-feed'
end

gem 'wdm', '>= 0.1.0' if Gem.win_platform?
26 changes: 11 additions & 15 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
PATH
remote: .
specs:
jekyll-theme-tallneck (0.1.0)
jekyll (~> 4.3)
jekyll-theme-tallneck (0.2.0)
jekyll (>= 4.0, < 5.0)
jekyll-feed (~> 0.17)
jekyll-seo-tag (~> 2.8)
jekyll-sitemap (~> 1.4)
jekyll-toc (~> 0.18)

GEM
remote: https://rubygems.org/
Expand All @@ -20,7 +20,7 @@ GEM
eventmachine (1.2.7)
ffi (1.16.3-x64-mingw-ucrt)
forwardable-extended (2.6.0)
google-protobuf (3.25.2-x64-mingw-ucrt)
google-protobuf (3.25.3-x64-mingw-ucrt)
http_parser.rb (0.8.0)
i18n (1.14.1)
concurrent-ruby (~> 1.0)
Expand All @@ -40,56 +40,52 @@ GEM
safe_yaml (~> 1.0)
terminal-table (>= 1.8, < 4.0)
webrick (~> 1.7)
jekyll-feed (0.17.0)
jekyll (>= 3.7, < 5.0)
jekyll-sass-converter (3.0.0)
sass-embedded (~> 1.54)
jekyll-seo-tag (2.8.0)
jekyll (>= 3.8, < 5.0)
jekyll-sitemap (1.4.0)
jekyll (>= 3.7, < 5.0)
jekyll-toc (0.18.0)
jekyll (>= 3.9)
nokogiri (~> 1.12)
jekyll-watch (2.2.1)
listen (~> 3.0)
kramdown (2.4.0)
rexml
kramdown-parser-gfm (1.1.0)
kramdown (~> 2.0)
liquid (4.0.4)
listen (3.8.0)
listen (3.9.0)
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
mercenary (0.4.0)
nokogiri (1.16.0-x64-mingw-ucrt)
racc (~> 1.4)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (5.0.4)
racc (1.7.3)
rake (13.1.0)
rb-fsevent (0.11.2)
rb-inotify (0.10.1)
ffi (~> 1.0)
rexml (3.2.6)
rouge (4.2.0)
safe_yaml (1.0.5)
sass-embedded (1.70.0-x64-mingw-ucrt)
sass-embedded (1.71.1-x64-mingw-ucrt)
google-protobuf (~> 3.25)
terminal-table (3.0.2)
unicode-display_width (>= 1.1.1, < 3)
unicode-display_width (2.5.0)
wdm (0.1.1)
webrick (1.8.1)

PLATFORMS
x64-mingw-ucrt

DEPENDENCIES
bundler
jekyll-feed
jekyll-seo-tag
jekyll-sitemap
jekyll-theme-tallneck!
jekyll-toc
rake
wdm (>= 0.1.0)

BUNDLED WITH
2.5.4
File renamed without changes.
77 changes: 43 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Tallneck

Tallneck is a Jeckyll theme for my personal blog. The name was inspired from one of the machines on my favorite game, Horizon Zero Dawn.
Tallneck is a Jekyll theme for blogs. It is a simple and clean theme with a focus on the responsiveness. Also js free.

Preview: [https://jotonedev.github.io/jekyll-theme-tallneck/](https://jotonedev.github.io/jekyll-theme-tallneck/)

## Installation

Expand All @@ -18,60 +20,64 @@ theme: jekyll-theme-tallneck

And then execute:

$ bundle
```bash
bundle
```

Or install it yourself as:

$ gem install jekyll-theme-tallneck

```bash
gem install jekyll-theme-tallneck
```

## Usage

### Customization
### Initial setup

Create a folder named `assets` in your Jekyll site's root directory.
Then create a folder named `images` inside the `assets` folder and put a replacement for the default banner image named `banner.png` (1200x630) inside it.
To set up your Jekyll site with the Tallneck theme, follow these steps:

After that, replace the `favicon.ico` and `favicon.svg` file in the root directory with your own favicon.
1. Install the theme as described above.
2. Add the following to your site's `_config.yml` to activate the theme:

Then, configure the various plugins in `_config.yml` to your liking. The plugins are:

- [jekyll-seo-tag](https://github.com/jekyll/jekyll-seo-tag)
- [jekyll-toc](https://github.com/toshimaru/jekyll-toc)
- [jekyll-sitemap](https://github.com/jekyll/jekyll-sitemap)

### Main pages
```yaml
plugins:
- jekyll-remote-theme
- jekyll-feed
- jekyll-seo-tag
- jekyll-sitemap

Create at the root of your Jekyll site the following pages:
theme: jekyll-theme-tallneck
```

- `about.md`, which will be the About page and set the permalink to `/about`
- `contact.md`, which will be the Contact page and set the permalink to `/contact`
- `cookie.md`, which will be the Cookie Policy page and set the permalink to `/cookie`
- `privacy.md`, which will be the Privacy Policy page and set the permalink to `/privacy`
- `terms.md`, which will be the Terms of Service page and set the permalink to `/terms`
3. Create the following files at the root of your Jekyll site and edit them like the ones in this repo:
- [index.md](index.md)
- [feed.md](feed.md)
- [404.md](404.md)
- [about.md](about.md)
- [cookie.md](cookie.md)
- [privacy.md](privacy.md)
- [terms.md](terms.md)

Also create the file `404.html` with the following content:
4. Create the `assets/image` folder and put a replacement for the following images:
- `favicon.ico` and `favicon.svg` that will be used as the favicon.
- `logo.svg` that will be used as the home button.
- `pwa_icon.svg`, `pwa_icon_x512.png`, `pwa_icon_x96.png` that will be used as the PWA icon. ([https://maskable.app/editor](https://maskable.app/editor) can be used to create the maskable icon)
5. In the `assets` folder, create the sitemanifest.json file and edit it to your liking.
6. [Optional] Customize the theme by creating the `_sass` folder and editing `custom_variables.scss` and `custom_styles.scss` files.
7. Edit the `_config.yml` file to your liking (you can use the [config](/_config.yml) file in this repo as a template).

```yaml
---
layout: 404
sitemap: false
---
```

### Writing posts

To create a new post, add a markdown file in the `_posts` directory and add at the top of the file the following:

```yaml
---
layout: post
layout: post # Optional, post is default
title: "First post!"
subtitle: "Written in Go."
subtitle: "Written in Go." # Optional
date: 2023-01-16 17:40:28 +0100
image:
path: /assets/images/golang.jpg
alt: golang logo
image: /assets/image/golang.jpg # Optional
---
```

Expand All @@ -82,8 +88,11 @@ To set up your environment to develop this theme, run `bundle install`.
Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.

When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
To add a custom directory to your theme-gem, please edit the regexp in `jotone_theme.gemspec` accordingly.

## License

The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Credits

Some of the css code was inspired from the [Minima Theme](https://github.com/jekyll/minima). [Minima license](https://github.com/jekyll/minima/blob/master/LICENSE.txt).
53 changes: 53 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
title: Tallneck test
language: en

copyright: "Copyright (c) 2024 John Toniutti"

author: John Toniutti
keywords: "tallneck, test, jekyll, theme, jekyll-theme-tallneck"
tagline: "Tallneck test | This a tagline"
description: "Preview for the theme Tallneck for Jeckyll."
url: "https://jotonedev.github.io/tallneck-test"

social: true
email: "[email protected]"
github_url: https://example.com/
gitlab_url: https://example.com/
discord_url: https://example.com/
linkedin_url: https://example.com/
reddit_url: https://example.com/
instagram_url: https://example.com/
threads_url: https://example.com/
x_url: https://example.com/
telegram_url: https://example.com/

about_image: "/assets/image/about.webp"
defaults:
- scope:
type: "posts"
values:
layout: "post"
image: "/assets/image/default.webp"
seo:
type: BlogPosting

sitemap: true

seo:
type: BlogPosting

feed:
posts_limit: 20

sass:
style: compressed
sass_dir: _sass

#cloudflare: "bb92f520037c4286aea634050df09d74"

# Build settings
theme: jekyll-theme-tallneck
plugins:
- jekyll-feed
- jekyll-seo-tag
- jekyll-sitemap
20 changes: 0 additions & 20 deletions _includes/article-preview.html

This file was deleted.

33 changes: 10 additions & 23 deletions _includes/footer.html
Original file line number Diff line number Diff line change
@@ -1,24 +1,11 @@
<footer class="container no_print">
<hr>
<div>
<nav>
<ul>
<li>
<a href="{{ '/privacy' | relative_url }}" rel="noopener noreferrer">Privacy</a>
</li>
<li>
<a href="{{ '/cookie' | relative_url }}" rel="noopener noreferrer">Cookie</a>
</li>
<li>
<a href="{{ '/terms' | relative_url }}" rel="noopener noreferrer">Terms</a>
</li>
<li>
<a href="{{ '/about' | relative_url }}" rel="noopener noreferrer">About</a>
</li>
<li>
<a href="{{ '/contacts' | relative_url }}" rel="noopener noreferrer">Contacts</a>
</li>
</ul>
</nav>
</div>
<footer class="page-footer">
<hr class="footer-hr">
<nav class="footer-nav">
<a href="{{ '/privacy' | relative_url }}" rel="noopener noreferrer">Privacy</a>
<a href="{{ '/cookie' | relative_url }}" rel="noopener noreferrer">Cookie</a>
<a href="{{ '/terms' | relative_url }}" rel="noopener noreferrer">Terms</a>
</nav>
{% if include.text %}
<p class="footer-text">{{include.text}}</p>
{% endif %}
</footer>
Loading