jekyll-koziolekweb-tags 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ce633e08c9c757a2af4a2f8058620ffc3f91c896097297046d6f40ce5b065e83
+  data.tar.gz: b3b81fe9441a1cfe89acd189a0b6e4c831b9a16d09c19abf9fe1ed7c6a5cfe41
+SHA512:
+  metadata.gz: 6dba95f4e83f2fb79caddcc5f716133bd84f00f1279cb3f0bb97ffa58b1957613284e159214b90c20edfd40240bce1eebd4a83eb3ca664ffe874aeec91ae87ae
+  data.tar.gz: 22b37801ec6c35b3b07457e34cbff6b9ce2a85e846bc437401094fcd54e5c7b1ec655a91c5750f171fac0f47cf20d6fb7a4d62258d00e96b31b05d956258b25c

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0
+
+New project were born…

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in jekyll-koziolekweb-tags.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "jekyll", ENV["JEKYLL_VERSION"] if ENV["JEKYLL_VERSION"]

data/README.md

@@ -0,0 +1,75 @@
+# Jekyll::Koziolekweb::Tags
+
+This is set of jekyll tags that I use on my blog. It helps generate some specific content like listings of code or aside notes.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add jekyll-koziolekweb-tags
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install jekyll-koziolekweb-tags
+
+## Usage
+
+There are few block tags that you can use.
+
+### offtopic
+
+If you put
+
+```
+{% offtopic DIRECTION %}
+Your text goes here
+{% endofftopic %}
+```
+
+in md file, then it will generate:
+
+```html
+
+<aside class="offtopic f-DIRECTION">
+    Your text goes here
+</aside>
+```
+
+I don't want to suggest anything abut css, but:
+
+* `offtopic` class should define most of layout
+* `f-DIRECTION` class should define `float` behaviour
+
+### listing
+
+If you put
+
+```
+{% listing LANG 'TITLE' %}
+Your code goes here
+{% endlisting %}
+```
+
+in md file, then it will generate:
+
+```html
+<p class="listing">Listing X. TITLE</p>
+\`\`\`LANG
+Your code goes here
+\`\`\`
+```
+
+and finally it will be processed by markdown engine to final form. `X` is an number of listing, starts from 1 and work in post context.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to
+experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and
+then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file
+to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Koziolek/jekyll-koziolekweb-tags.

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/jekyll/koziolekweb/tags/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Koziolekweb
+    module Tags
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/jekyll/koziolekweb/tags.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative "tags/version"
+
+module Koziolekweb
+  module Tags
+    class Listing < Liquid::Block
+      @@file_state = {}
+
+      def initialize(tag_name, markup, tokens)
+        super
+
+        matched = /(\w+)\s+["'](.*?)["']/.match(markup)
+
+        if matched
+          @lang = matched[1]
+          @title = matched[2]
+        else
+          raise SyntaxError.new("
+            Invalid parameters for listing. Usage:
+                {% listing lang 'title' %}
+                code goes here
+                {% endlisting %}
+            got
+            #{markup}")
+        end
+      end
+
+      def render(context)
+        current_file = context.registers[:page]["path"]
+        @@file_state[current_file] ||= 0
+        @@file_state[current_file] += 1
+        content = super
+        content_with_code_fence = "```#{@lang} #{content}```"
+
+        "<p class='listing'> Listing #{@@file_state[current_file]}. #{@title}</p>#{content_with_code_fence}"
+      end
+    end
+
+    class Offtop < Liquid::Block
+
+      def initialize(tag_name, markup, tokens)
+        super
+        @direction = markup
+      end
+
+      def render(context)
+        content = super
+        "<aside class=\"offtopic f-#{@direction}\">#{content}</aside>"
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('listing', Koziolekweb::Tags::Listing)
+Liquid::Template.register_tag('offtop', Koziolekweb::Tags::Offtop)

data/sig/jekyll/koziolekweb/tags.rbs

@@ -0,0 +1,8 @@
+module Jekyll
+  module Koziolekweb
+    module Tags
+      VERSION: String
+      # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+    end
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-koziolekweb-tags
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Koziolek
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Here you will find a set of tags that allow you to create code listings
+  with numbering, notes using the <aside> element and more.
+email:
+- bjkuczynski@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- lib/jekyll/koziolekweb/tags.rb
+- lib/jekyll/koziolekweb/tags/version.rb
+- sig/jekyll/koziolekweb/tags.rbs
+homepage: https://github.com/Koziolek/jekyll-koziolekweb-tags
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/Koziolek/jekyll-koziolekweb-tags
+  changelog_uri: https://github.com/Koziolek/jekyll-koziolekweb-tags/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.4
+signing_key: 
+specification_version: 4
+summary: Set of structural tags that helps to organise article.
+test_files: []