diff --git a/.github/workflows/gem-push.yml b/.github/workflows/gem-push.yml
index 9c9fc60..91af009 100644
--- a/.github/workflows/gem-push.yml
+++ b/.github/workflows/gem-push.yml
@@ -1,4 +1,4 @@
-name: Ruby Gem
+name: Gem publish
on:
push:
@@ -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
diff --git a/.github/workflows/test-build.yml b/.github/workflows/test-build.yml
new file mode 100644
index 0000000..ee7bb1d
--- /dev/null
+++ b/.github/workflows/test-build.yml
@@ -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
diff --git a/.gitignore b/.gitignore
index 4fab8e0..85d9342 100644
--- a/.gitignore
+++ b/.gitignore
@@ -60,4 +60,6 @@ _site/
.jekyll-cache/
.jekyll-metadata
-# End of https://mrkandreev.name/snippets/gitignore-generator/#Ruby,Jekyll
\ No newline at end of file
+*.pdn
+.idea/
+.vscode/
diff --git a/404.md b/404.md
new file mode 100644
index 0000000..63fa170
--- /dev/null
+++ b/404.md
@@ -0,0 +1,6 @@
+---
+layout: 404
+private: true
+no_meta: true
+sitemap: false
+---
\ No newline at end of file
diff --git a/Gemfile b/Gemfile
index 6809d77..5ffda7c 100644
--- a/Gemfile
+++ b/Gemfile
@@ -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?
diff --git a/Gemfile.lock b/Gemfile.lock
index d370304..562aae5 100644
--- a/Gemfile.lock
+++ b/Gemfile.lock
@@ -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/
@@ -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)
@@ -40,15 +40,14 @@ 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)
@@ -56,28 +55,25 @@ GEM
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
@@ -85,11 +81,11 @@ PLATFORMS
DEPENDENCIES
bundler
+ jekyll-feed
jekyll-seo-tag
jekyll-sitemap
jekyll-theme-tallneck!
- jekyll-toc
- rake
+ wdm (>= 0.1.0)
BUNDLED WITH
2.5.4
diff --git a/LICENSE.txt b/LICENSE
similarity index 100%
rename from LICENSE.txt
rename to LICENSE
diff --git a/README.md b/README.md
index 1124a97..52a3668 100644
--- a/README.md
+++ b/README.md
@@ -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
@@ -18,46 +20,52 @@ 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
@@ -65,13 +73,11 @@ To create a new post, add a markdown file in the `_posts` directory and add at t
```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
---
```
@@ -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).
diff --git a/_config.yml b/_config.yml
new file mode 100644
index 0000000..7bbf493
--- /dev/null
+++ b/_config.yml
@@ -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: "test@example.com"
+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
diff --git a/_includes/article-preview.html b/_includes/article-preview.html
deleted file mode 100644
index f3185f7..0000000
--- a/_includes/article-preview.html
+++ /dev/null
@@ -1,20 +0,0 @@
-
-
-
\ No newline at end of file
diff --git a/_includes/footer.html b/_includes/footer.html
index ce19a95..b6610ff 100644
--- a/_includes/footer.html
+++ b/_includes/footer.html
@@ -1,24 +1,11 @@
-