jekyll-theme-low 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e1dd70696e840536c7f56a927149ce557a041a58ac157c3ffb05a6abf88492c
-  data.tar.gz: d4fe0e3f0f300255f9b2d103ec910a9b9c1c6fce8b4aeda5e60daafaa8c090ec
+  metadata.gz: 3aea22681c895bd8b8107a7095fd740b82463bf39f23fdbca0bfab5a0c9b86b5
+  data.tar.gz: 3899265938c1fe60ba0a8b062a125cfd026dac8af30f2fab0868eb8c317c2646
 SHA512:
-  metadata.gz: bc77ed2037d73b1b2c1cc0e8b29f05f74a6b57fac5233b6b25a57984c884a0394662d7f9d9b25778fb04b152ea0ce8043cfd836d18ac20f7623ef6ebefbf24e4
-  data.tar.gz: dcf6d617bd52a9b03c0ba07af9044f703a850eec852d82e44c63272a81067383d21b841d662bb632aa4c9519b763fbc5746d0f645b77aeb4291537002d86dcd4
+  metadata.gz: a10835290d900633298faf1a7625eca34fa7e5648a248cab7fdfb4ff99dae130589d55d98a58832563f0322c8bc222065f3c063039b9f448f4089ed86b658d38
+  data.tar.gz: 3137aacc6539e9da31729bdcec8270739a1186d69efffa36cd324a63e82a97bead935c13f1b8d7cc986b5e3ce5da27b2ef95ff61eb38e7ec7c224f67b5b0dd94

data/README.md

@@ -1,11 +1,11 @@
 # low
 
-![ss](./docs/ss.png)
+![Screenshot](./docs/ss.png)
 
 > A minimal, retro-inspired Jekyll theme for engineers who care about the metal.
 
-**low** is a lightweight Jekyll theme designed for technical blogging — inspired by [Fabien Sanglard’s website](https://fabiensanglard.net/).  
-It’s meant for developers who write about *low-level programming, graphics, operating systems, emulation, and the craft of software*.
+**low** is a lightweight Jekyll theme designed for technical blogging — inspired by [Fabien Sanglard's website](https://fabiensanglard.net/).  
+It's meant for developers who write about *low-level programming, graphics, operating systems, emulation, and the craft of software*.
 
 No JavaScript frameworks. No build pipelines. Just clean HTML, monospace typography, and focus on content.
 
@@ -13,82 +13,210 @@ No JavaScript frameworks. No build pipelines. Just clean HTML, monospace typogra
 
 ## ✳ Features
 
-- ⚙️ **Zero-dependency design** — pure HTML + CSS, no JavaScript.
-- 💾 **Retro technical aesthetic** — monospaced typography and print-like layout.
-- 🧱 **Simple structure** — easily fork, modify, or embed in existing Jekyll setups.
-- 📰 **RSS + SEO ready** — via `jekyll-feed`, `jekyll-seo-tag`, and `jekyll-sitemap`.
-- 🗓️ **Archive view** — grouped by year, auto-generated from posts.
-- 🖋️ **Clean code blocks** — styled for low-level and C-style syntax.
-- 🪶 **Compact footer** — © year + author, nothing more.
+- ⚙️ **Zero-dependency design** — pure HTML + CSS, no JavaScript
+- 💾 **Retro technical aesthetic** — monospaced typography and print-like layout
+- 🧱 **Simple structure** — easily fork, modify, or embed in existing Jekyll setups
+- 📰 **RSS + SEO ready** — via `jekyll-feed`, `jekyll-seo-tag`, and `jekyll-sitemap`
+- 🗓️ **Archive view** — grouped by year, auto-generated from posts
+- 🖋️ **Clean code blocks** — styled for low-level and C-style syntax
+- 🪶 **Compact footer** — © year + author, nothing more
+
+---
+
+## ⚡ Installation
+
+### Option 1: Add to Existing Site
+
+Add this line to your Jekyll site's `Gemfile`:
+
+```ruby
+gem "jekyll-theme-low"
+```
+
+And add this line to your `_config.yml`:
+
+```yaml
+theme: jekyll-theme-low
+```
+
+Then execute:
+
+```bash
+bundle install
+```
+
+### Option 2: Create New Site
+
+```bash
+jekyll new my-blog
+cd my-blog
+```
+
+Edit `Gemfile` and add:
+
+```ruby
+gem "jekyll-theme-low"
+```
+
+Edit `_config.yml` and add:
+
+```yaml
+theme: jekyll-theme-low
+```
+
+Then run:
+
+```bash
+bundle install
+bundle exec jekyll serve
+```
 
 ---
 
 ## 🧩 Directory Structure
 
-```sh
+```
 low/
 ├── _layouts/
-│ ├── default.html # Base layout (includes header/footer)
-│ ├── home.html # Main index page
-│ ├── post.html # Individual post layout
-│ └── archive.html # Yearly archive page
+│   ├── default.html      # Base layout (includes header/footer)
+│   ├── home.html         # Main index page
+│   ├── post.html         # Individual post layout
+│   └── archive.html      # Yearly archive page
 │
 ├── _includes/
-│ ├── head.html # Metadata + styles
-│ ├── header.html # Top navigation bar
-│ ├── footer.html # Minimal one-liner footer
-│ ├── post-list.html # Reusable post index
-│ └── post-meta.html # Date + tags for posts
+│   ├── head.html         # Metadata + styles
+│   ├── header.html       # Top navigation bar
+│   ├── footer.html       # Minimal one-liner footer
+│   ├── post-list.html    # Reusable post index
+│   └── post-meta.html    # Date + tags for posts
 │
 ├── assets/
-│ └── css/
-│ └── main.scss # Global theme styles
+│   └── css/
+│       └── main.scss     # Global theme styles
 │
 ├── _sass/
-│ └── theme/
-│ └── _syntax.scss # Rouge syntax highlighting
+│   └── theme/
+│       └── _syntax.scss  # Rouge syntax highlighting
 │
-└── low.gemspec # Jekyll theme definition
+└── low.gemspec           # Jekyll theme definition
 ```
 
-## ⚡ Installation
+---
+
+## 🧭 Example Site
 
-Add it to your Jekyll site:
+The theme ships with an `example/` directory that demonstrates:
 
-```sh
-bundle add low
+- Index page listing posts under "Articles"
+- `/archive/` for yearly grouping
+- `/rss.xml` for feed readers
+
+Run it locally:
+
+```bash
+cd example
+bundle install
+bundle exec jekyll serve
 ```
 
-## 🧠 Philosophy
+Then open: http://127.0.0.1:4000
 
-This theme follows the same principles as the projects it’s meant to host:
+---
 
-- Understand what runs under the hood.
-- Respect simplicity.
-- Prefer text over tools.
+## 🎨 Customization
 
-It’s ideal for developers writing deep dives into:
-- retro-game rendering,
-- CPU emulation,
-- assembly or C,
-- framebuffer graphics,
-- or OS development logs.
+### Basic Configuration
 
-## 🧭 Example Site
-The theme ships with an `example/` site that demonstrates:
-- index listing posts under Articles,
-- /archive/ for yearly grouping,
-- /rss.xml for feed readers.
+Edit your `_config.yml`:
 
-Run it locally:
-```sh
-cd example
-bundle exec jekyll serve
+```yaml
+title: Your Site Title
+author: Your Name
+description: A technical blog about low-level programming
+url: "https://yourdomain.com"
+
+# Plugins
+plugins:
+  - jekyll-feed
+  - jekyll-seo-tag
+  - jekyll-sitemap
 ```
 
-Open: http://127.0.0.1:4000
+### Creating Posts
+
+Create a file in `_posts/` directory:
+
+```markdown
+---
+layout: post
+title: "My First Post"
+date: 2025-11-05
+categories: programming
+---
+
+Your content here...
+```
+
+### Adding Pages
+
+Create pages in the root directory:
+
+```markdown
+---
+layout: default
+title: About
+permalink: /about/
+---
+
+About me...
+```
+
+---
+
+## 🧠 Philosophy
+
+This theme follows the same principles as the projects it's meant to host:
+
+- Understand what runs under the hood
+- Respect simplicity
+- Prefer text over tools
+
+It's ideal for developers writing deep dives into:
+
+- Retro-game rendering
+- CPU emulation
+- Assembly or C programming
+- Framebuffer graphics
+- OS development logs
+
+---
 
 ## 🪞 Credit
 
-Heavily inspired by the aesthetic and minimalism of
-Fabien Sanglard
+Heavily inspired by the aesthetic and minimalism of [Fabien Sanglard](https://fabiensanglard.net/).
+
+---
+
+## 📄 License
+
+The theme is available as open source under the terms of the [MIT License](LICENSE).
+
+---
+
+## 🤝 Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[username]/jekyll-theme-low
+
+---
+
+## 📮 Support
+
+If you encounter any issues or have questions:
+
+1. Check the [example site](./example/) for reference
+2. Open an issue on GitHub
+3. Read the [Jekyll documentation](https://jekyllrb.com/docs/)
+
+---
+
+**Made with ❤️ for the low-level community**

data/_layouts/home.html

@@ -14,4 +14,4 @@ layout: default
 Ongoing...: <a href="{{ '/projects/' | relative_url }}">Projects</a><br>
 
 <hr>
-<center class=".sun">*</center>
+<center ><span class=".sun">*</span></center>

data/lib/low/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Low
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-low
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Levent Kaya
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-11-05 00:00:00.000000000 Z
+date: 2025-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll