jekyll-theme-nocc 2.0.0 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f68377affd630caa0340fd472f07e1ccd3f1c5c4d4bbf8e0fd1ebe27830775b8
-  data.tar.gz: 82548b646b5ee01ec9daf055fb7002e10c7f984bd7b738040a85a535597c971b
+  metadata.gz: 4288d6988499cc0e80908ee8e434b0d2e4132a27a77fbfba44163d5290c03e27
+  data.tar.gz: 0a3768ebf8fd4ab34d7be73918e8f2d1ad3048cf013ac9a564170cfa0f3b0582
 SHA512:
-  metadata.gz: 10fe510840c716834157dc4f6e129c15addccd67cc3d3cc66f56fc07d81f9085ee6bcd79509e664c47b9b4abf8a8ed4e15532bdb37e1ff11027c4ff1abd28440
-  data.tar.gz: d7ae379b4925859bbe516dc3fcb49f819145f2a1e65be9253b4b5b958e083322438285e4f8954051aafcf841f678c3f54e8059d53b97ef5435896e51904d4bfa
+  metadata.gz: 55a51971456413057b6834a278881eb0782680c73de9934d03e1e2490c0b2c38fbcce64e6e8dff9f366072ee3fb4d8da7a6f8c0541fa4b8b67399f27129214da
+  data.tar.gz: 6a1d7f12dc637a962ef2cab2646b15057b2a9d490edbdcfa3684c2c29db718d3279f808fa4e706f6fdb7d480183d8af7ed848cba02dc1102d4653dcf45cf3417

data/README.md

@@ -1,4 +1,6 @@
-# jekyll-theme-nocc
+# Jekyll Theme: NOCC Bootstrap Jekyll Theme
+
+This README provides instructions for installing and configuring the NOCC Bootstrap Jekyll Theme.
 
 ## Introduction
 
@@ -8,22 +10,30 @@
 
 It comes in three powerful options:
 
-- **💎 Theme Jekyll Nocc**: A Ruby gem that brings the power of NOCC directly to your Jekyll project. [Get it now!](https://rubygems.org/gems/jekyll-theme-nocc).
-- **🌟 Nocc Bootstrap Theme**: An NPM Package that brings the power of NOCC directly to your NodeJS project. [Get it now!](https://www.npmjs.com/package/nocc-bootstrap-theme).
-- **🌐 Full Site Bundle for Jekyll**: A complete static website showcasing NOCC's seamless integration. Featuring a beautifully designed homepage, dynamic tag cloud, image gallery, and more. [Explore on GitHub](https://github.com/carlesloriente/bootstrap-theme-jekyll).
+- **💎 [Theme Jekyll Nocc](https://rubygems.org/gems/jekyll-theme-nocc)**: A Ruby gem that brings the power of NOCC directly to your Jekyll project.
+- **🌟 [Nocc Bootstrap Theme](https://www.npmjs.com/package/nocc-bootstrap-theme)**: An NPM Package that brings the power of NOCC directly to your NodeJS project.
+- **🌐 [Full Site Bundle for Jekyll](https://github.com/carlesloriente/bootstrap-theme-jekyll)**: A complete static website showcasing NOCC's seamless integration. Featuring a beautifully designed homepage, dynamic tag cloud, image gallery, and more.
 
 > **ⓘ** NOCC is a complete replacement for Bootstrap 5.3.3
 
 ## Table of contents
 
-- [jekyll-theme-nocc](#jekyll-theme-nocc)
+- [Jekyll Theme: NOCC Bootstrap Jekyll Theme](#jekyll-theme-nocc-bootstrap-jekyll-theme)
   - [Introduction](#introduction)
   - [Table of contents](#table-of-contents)
   - [Features](#features)
   - [Installation](#installation)
-  - [Usage](#usage)
+    - [1. Add the theme to your Gemfile](#1-add-the-theme-to-your-gemfile)
+    - [2. Specify the theme in your \_config.yml](#2-specify-the-theme-in-your-_configyml)
+    - [3. Install the theme](#3-install-the-theme)
+  - [Setting up the theme](#setting-up-the-theme)
+    - [1. Modify \_config.yml](#1-modify-_configyml)
+    - [2. Modify index.markdown](#2-modify-indexmarkdown)
+  - [How to enable](#how-to-enable)
+    - [Tags section](#tags-section)
+    - [Contact form](#contact-form)
+    - [Gallery section](#gallery-section)
   - [Contributing](#contributing)
-  - [Development](#development)
   - [Creator](#creator)
   - [Thanks](#thanks)
   - [Copyright and License](#copyright-and-license)
@@ -38,42 +48,228 @@ It comes in three powerful options:
 
 ## Installation
 
-Add this line to your Jekyll site's `Gemfile`:
+### 1. Add the theme to your Gemfile
+
+Add the following line to your Jekyll site's `Gemfile`:
 
 ```ruby
 gem "jekyll-theme-nocc"
 ```
 
-And add this line to your Jekyll site's `_config.yml`:
+### 2. Specify the theme in your _config.yml
+
+Add the following line to your Jekyll site's _config.yml file:
 
 ```yaml
 theme: jekyll-theme-nocc
 ```
 
-And then execute:
+### 3. Install the theme
 
-    $ bundle
+Execute the following command in your terminal:
 
-Or install it yourself as:
+```bash
+bundle
+```
 
-    $ gem install jekyll-theme-nocc
+Alternatively, you can install it directly using gem:
 
-## Usage
+```bash
+gem install jekyll-theme-nocc
+```
 
-TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.
+## Setting up the theme
 
-## Contributing
+### 1. Modify _config.yml
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/carlesloriente/jekyll-theme-nocc. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://www.contributor-covenant.org/) code of conduct.
+Edit your Jekyll site's _config.yml file.  It's recommended to add the following plugins after the jekyll-feed plugin if you're using it, to avoid potential conflicts:
+
+```yaml
+plugins:
+  - jekyll-feed
+  - jekyll-paginate
+  - jekyll-redirect-from
+```
+
+Next, add the following configuration options to your _config.yml file, replacing the placeholder values with your own:
+
+```yaml
+author: Your Name
+author_url: "https://www.yoururl.com"
+timezone: "Europe/Madrid" # Timezone for your site
+full_description: >
+  A long description of your site.  This can span multiple lines.
+gh_repository: https://github.com/yourusername/yourrepo
+encoding: "utf-8"
+locale: "en-US" # Language and locale
+lang: "en" # Language code
+email: "your_email_address"
+permalink: pretty # URL structure for posts
+
+# Site Manifest (for PWA support)
+name: "Site name"
+short_name: "NAME"
+language: "en"
+lang_direction: "ltr"
+color: "#FFFFFF" # Background color for manifest
+
+# Social Profiles
+linkedin_username: your_linkedin_username
+
+# Google Analytics (Optional)
+google_analytics: "G-XXXXXXXXXX" # Your Google Analytics tracking ID
+google_site_verification: "YOUR_GOOGLE_SITE_VERIFICATION_TOKEN" # Optional: For Google Search Console verification.
+google_adsense_account: "ca-pub-XXXXXXXXXXXXXXXX" # Optional: Your AdSense account ID
+google_tag_id: "GTM-XXXXXXX" # Optional: Your Google Tag Manager ID
+
+# Disqus Comments (Optional)
+disqus_shortname: your_disqus_shortname # Leave blank to disable comments site-wide.  You can disable comments on individual posts by adding `comments: false` to the post's YAML front matter.
+
+# Formspree Contact Form
+formemail: "your_formemail_address" # Your Formspree email address (see "How to enable the contact form" section)
+
+# Theme Information (Please do not remove these)
+theme_version           : v2.0.2
+theme_name              : NOCC Bootstrap Jekyll Theme
+theme_repo              : https://github.com/carlesloriente/jekyll-theme-nocc/
+theme_url               : https://bootstrap-theme.notesoncloudcomputing.com/
+theme_author            : Carles Loriente
+theme_author_url        : https://www.notesoncloudcomputing.com/about/
+theme_download          : https://github.com/carlesloriente/jekyll-theme-nocc/archive/refs/heads/main.zip
+theme_package           : https://rubygems.org/gems/jekyll-theme-nocc
+theme_logo              : "/assets/vendor/nocc-bootstrap-theme/images/nocc/nocc_logo.webp"
+
+exclude: ["AUTHORS.md", "CODE_OF_CONDUCT.md", "CONTRIBUTING.md", "CODEOWNERS", "LICENSE", "README.md", "SECURITY.md", "WORKFLOW.md", "Gemfile", "Gemfile.lock", "vendor/bundle/", "vendor/cache/", "vendor/gems/", "vendor/ruby/"]
+```
+
+### 2. Modify index.markdown
+
+Edit your `index.markdown` file and add the following front matter parameters after `layout: home`:
+
+```markdown
+background: '/assets/images/bg-index.webp'
+carousel:
+  - '/assets/images/bg-index.webp'
+  - '/assets/images/bg-index-2.webp'
+  - '/assets/images/bg-index-3.webp'
+```
+
+## How to enable
+
+### Tags section
+
+**1. Create a new file named tags.markdown in your site's root directory**.
 
-## Development
+**2. Add the following content to tags.markdown**:
 
-To set up your environment to develop this theme, run `bundle install`.
+```markdown
+---
+title: Tags list
+layout: tags_index
+permalink: /tags/
+description: A tag cloud from posts
+categories: tags
+background: '/assets/images/bg-gallery.webp'
+tagsindex: true
+---
+```
+
+**3. To add tags to your posts, include the tags front matter parameter in your post files**:
+
+```markdown
+tags:
+- firsttag
+- secondtag
+- another-tag
+```
+
+### Contact form
+
+This theme uses Formspree to handle contact form submissions.
+
+1. Create a Formspree account: Sign up for a free account at [FormSpree](https://formspree.io/).
+
+2. Create a new form in your Formspree account.
+
+3. Create a new file named `contact.html` in your site's root directory.
+
+4. Add the contact form code: Add the following content to contact.html, replacing `YOUR_FORM_ID` with the ID from your Formspree form (you'll find it in the Formspree form's setup instructions):
+
+```html
+---
+layout: page
+title: Contact
+permalink: /contact/
+description: Contact me form
+categories: contact me
+background: '/assets/images/bg-contact.webp'
+form: true
+---
+
+    <p>Want to get in touch? Send me a message!</p>
+    <form name="sentMessage" id="contactForm" novalidate>
+      <div class="control-group">
+        <div class="form-group floating-label-form-group controls">
+          <label>Name</label>
+          <input type="text" class="form-control" placeholder="Name" id="name" required data-bs-validation-required-message="Please enter your name.">
+          <p class="help-block text-danger"></p>
+        </div>
+      </div>
+      <div class="control-group">
+        <div class="form-group floating-label-form-group controls">
+          <label>Email Address</label>
+          <input type="email" class="form-control" placeholder="Email Address" id="email" required data-bs-validation-required-message="Please enter your email address.">
+          <p class="help-block text-danger"></p>
+        </div>
+      </div>
+      <div class="control-group">
+        <div class="form-group floating-label-form-group controls">
+          <label>Message</label>
+          <textarea rows="5" class="form-control" placeholder="Message" id="message" required data-bs-validation-required-message="Please enter a message."></textarea>
+          <p class="help-block text-danger"></p>
+        </div>
+      </div>
+      <br>
+      <div id="success"></div>
+      <div class="form-group">
+        <button type="submit" class="btn btn-primary float-end" id="sendMessageButton">Send</button>
+      </div>
+    </form>
+```
+
+Configure `formemail` in `_config.yml`: While the form submits directly to Formspree, you should still set the formemail option in your `_config.yml` file. This is used by the theme for other purposes, even if not directly related to the contact form itself.
+
+You can use a service like Firefox Relay to protect your actual email address.
+
+```yaml
+formemail               : "form@email.com"
+```
 
-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.
+### Gallery section
 
-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 `jekyll-theme-nocc.gemspec` accordingly.
+1. Create the gallery directory: Create a directory named `gallery` inside your `assets/images` directory.
+
+2. Add images: Place all the images you want to display in the gallery section into the newly created `gallery` directory.
+
+3. Create a new file named `gallery.html` in your site's root directory.
+
+4. Add the following content to gallery.html:
+
+```html
+---
+layout: images_gallery
+title: Gallery
+description: A gallery of images used in the article header.
+categories: gallery images
+background: '/assets/images/bg-gallery.webp'
+---
+```
+
+This will automatically display all images found in the `assets/images/gallery` directory.  The `images_gallery` layout handles the display logic. No further configuration is usually required.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/carlesloriente/jekyll-theme-nocc. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://www.contributor-covenant.org/) code of conduct.
 
 ## Creator
 

data/_config.yml

@@ -1,44 +1,33 @@
 landing                 : false
-title                   : NOCC
+title                   : Site title
 author                  : Your Name
-url                     : "https://www.yoururl.com"
+url                     : "https://www.yoursiteurl.com"
 author_url              : "https://www.yoururl.com"
 baseurl                 : "/" 
 timezone                : "Europe/Madrid"
-description             : A responsive dual theme using Bootstrap 5 for Jekyll created by Carles Loriente.
+description             : Short description of your site.
 full_description        : >
- A responsive dual theme using Bootstrap 5 for Jekyll created by Carles Loriente. Featuring a homepage, about page, tags cloud page, gallery of images page, examples post pages, post comments powered by Disqus, and contact page form powered by Formspree.
+ A long description of your site.
 gh_repository           : https://github.com/yourusername/yourrepo/
 encoding                : "utf-8"
 locale                  : "en-US"
 lang                    : "en"
-formemail               : 
+formemail               : "form@email.com"
+email                   : "you@email.com"
 permalink               : pretty
 
 # Manifest
-name                    : "NOCC Boostrap Jekyll Theme"
-short_name              : "NOCC"
+name                    : "Site name"
+short_name              : "NAME"
 language                : "en"
 lang_direction          : "ltr"
 color                   : "#FFFFFF"
 
-# Theme Notice (please don't remove it ;))
-theme_version           : v2.0.0
-theme_name              : NOCC Bootstrap Jekyll Theme
-theme_repo              : https://github.com/carlesloriente/jekyll-theme-nocc/
-theme_url               : https://bootstrap-theme.notesoncloudcomputing.com/
-theme_author            : Carles Loriente
-theme_author_url        : https://www.notesoncloudcomputing.com/about/
-theme_download          : https://github.com/carlesloriente/jekyll-theme-nocc/archive/refs/heads/main.zip
-theme_package           : https://rubygems.org/gems/jekyll-theme-nocc
-theme_logo              : "/assets/vendor/nocc-bootstrap-theme/images/nocc/nocc_logo.webp"
-
-# Social Profiles
-email                   : "you@email.com"
-twitter_username        : 
+# Add your Social Profiles
+twitter_username        :
 github_username         : 
 linkedin_username       : 
-kofi                 : 
+kofi                    : 
 
 # Add your google-analytics ID here to activate google analytics
 google_site_verification: 
@@ -46,11 +35,23 @@ google_analytics        :
 google_adsense_account  : 
 google_tag_id           : 
 
-# Disqus Comments
-# Leave shortname blank to disable comments site-wide.
+# Disqus Comments. Leave shortname blank to disable comments site-wide.
 # Disable comments for any post by adding `comments: false` to that post's YAML Front Matter.
 disqus_shortname        : 
 
+
+# Theme Notice (please don't remove it ;))
+theme_version           : v2.0.0
+theme_name              : NOCC Bootstrap Jekyll Theme
+theme_repo              : https://github.com/carlesloriente/jekyll-theme-nocc/
+theme_url               : https://bootstrap-theme.notesoncloudcomputing.com/
+theme_author            : Carles Loriente
+theme_author_url        : https://www.notesoncloudcomputing.com/about/
+theme_download          : https://github.com/carlesloriente/jekyll-theme-nocc/archive/refs/heads/main.zip
+theme_package           : https://rubygems.org/gems/jekyll-theme-nocc
+theme_logo              : "/assets/vendor/nocc-bootstrap-theme/images/nocc/nocc_logo.webp"
+
+# Site settings
 includes_dir            : _includes
 layouts_dir             : _layouts
 plugins_dir             : _plugins
@@ -88,7 +89,7 @@ kramdown:
 
 # Build settings
 paginate                : 20
-paginate_path           : "/notes/page:num/"
+paginate_path           : "/posts/page:num/"
 plugins:
   - jekyll-feed
   - jekyll-paginate

data/_plugins/_build_tags.rb

@@ -0,0 +1,33 @@
+module Jekyll
+  class TagIndex < Page
+    def initialize(site, base, dir, tag)
+      @site = site
+      @base = base
+      @dir = dir
+      @name = 'index.html'
+      self.process(@name)
+      self.read_yaml(File.join(base, '_layouts'), 'tag.html')
+      self.data['tag'] = tag
+      self.data['title'] = "#{tag}"
+      self.data['description'] = "List of posts with tag #{tag}."
+      self.data['og:description'] = "List of posts with tag #{tag}."
+    end
+  end
+  class TagGenerator < Generator
+    safe true
+    def generate(site)
+      if site.layouts.key? 'tag'
+        dir = site.config['tags_dir'] || 'tag'
+        site.tags.keys.each do |tag|
+          write_tag_index(site, File.join(dir, tag), tag)
+        end
+      end
+    end
+    def write_tag_index(site, dir, tag)
+      index = TagIndex.new(site, site.source, dir, tag)
+      index.render(site.layouts, site.site_payload)
+      index.write(site.dest)
+      site.pages << index
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-nocc
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.2
 platform: ruby
 authors:
 - Carles Loriente
 bindir: bin
 cert_chain: []
-date: 2025-02-15 00:00:00.000000000 Z
+date: 2025-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -150,6 +150,7 @@ files:
 - _layouts/posts_index.html
 - _layouts/tag.html
 - _layouts/tags_index.html
+- _plugins/_build_tags.rb
 - _sass/_custom.scss
 - assets/css/styles.scss
 - assets/images/404.webp
@@ -267,9 +268,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="