jekyll_pre 1.4.6 → 1.4.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b84c77d011c319901f75350aab6ecfcad105dcaa3068b478911150d6fccc4b4
-  data.tar.gz: 6d6a2852fb621a33bb09b3ca9084be581b543f9022213728fbba5396f6864b67
+  metadata.gz: 485abe28bdb36d30646e8213ac2efdc676137aedf5338110dbf03afd298f6c26
+  data.tar.gz: 8b968700fa134af7785c4ae7eb83386231c8a8a43db80aa7a4d5a1df06707850
 SHA512:
-  metadata.gz: d92536fab946b2917acfe3e9f442514a1be3ca1d7cf5b0073118451c71496a9f55e912b3e0e509d7ac40e3bea65e74d398e23ca05c5207589e214cacfb8d0453
-  data.tar.gz: 3629760054527aac3d0447d65ba6ccf90873d750e1345d1214a19d915e8bbf5052346f7606d8e53b085d0a575dc24ac2b9bf290c94980dec17d5178f7a9b11bc
+  metadata.gz: fc4b43a1640ebd2b02c04a149cc463e86fb06d68ad676d8a9647f9b7a71ca3ac695ae216e2843dffcae96c1c57f3883241852990cb7fa6dd65d8d2120b558a2f
+  data.tar.gz: 73f99f9496fb90edb52e486b85426070906139cf5143e9cfeed1a954aee6f1247ba64e709f31d88cabf1aecccfc3bab1a9299cd3b5357bc8ce724581326fb9cf

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Change Log
 
+## 1.4.8
+
+* `id` option added.
+
+
+## 1.4.7
+
+* `dark` and `bg_yellow` css tags now have black text.
+* `exec` works again.
+
+
 ## 1.4.6
 
 * Made compatible with `jekyll_plugin_support` v1.0.0

data/README.md

@@ -1,79 +1,89 @@
 # Jekyll_pre [![Gem Version](https://badge.fury.io/rb/jekyll_pre.svg)](https://badge.fury.io/rb/jekyll_pre)
 
-This Jekyll plugin provides 3 new Liquid tags that work together:
+This Jekyll plugin provides 3 new Liquid tags that work together: `pre`, `noselect` and `exec`.
 
-* A `pre` block tag that can be displayed various ways.
+## Provided Tags
 
-  ```html
-  {% pre [Options] [free text label] %}
-  Contents of pre tag
-  {% endpre %}
-  ```
+### `Pre`
 
-  `Options` are:
+A `pre` block tag can be displayed various ways.
 
-    - `class="class1 class2"` – Apply CSS classes
-    - `clear` – Line break after floating HTML elements
-    - `copyButton` – Generate a copy button
-    - `dark` – Dark mode
-    - `dedent` &ndash; Remove leading spaces common to all lines, like Ruby's <<~ squiggly heredoc (default is false)
-    - `label='This is a label'` &ndash; Apply text above `pre` tag.
-      The `label` parameter value can also be specified in free text.
-      For example, the following produce the same results:
+```html
+{% pre [Options] [free text label] %}
+Contents of pre tag
+{% endpre %}
+```
 
-      - {% pre label="This is a label" %}<br>Contents of pre tag<br>{% endpre %}
+`Options` are:
 
-      - {% pre This is a label %}<br>Contents of pre tag<br>{% endpre %}
-    - `number` &ndash; Number the lines
-    - `shell` &ndash; Equivalent to `label='Shell'`
-    - `style` &ndash; Apply inline CSS styles
+  * `class="class1 class2"` &ndash; Apply CSS classes
+  * `clear` &ndash; Line break after floating HTML elements
+  * `copyButton` &ndash; Generate a copy button
+  * `dark` &ndash; Dark mode
+  * `dedent` &ndash; Remove leading spaces common to all lines, like Ruby's <<~ squiggly heredoc (default is false)
+  * `id` &dash; Generate an `id` with the given value for the generated output.
+  * `label='This is a label'` &ndash; Apply text above `pre` tag.
+    The `label` parameter value can also be specified in free text.
+    For example, the following produce the same results:
 
-  The generated &lt;pre>&lt;/pre> tag has an `data-lt-active="false"` attribute, so
-  [LanguageTool](https://forum.languagetool.org/t/avoid-spell-check-on-certain-html-inputs-manually/3944)
-  does not check the spelling or grammar of the contents.
+    * {% pre label="This is a label" %}<br>Contents of pre tag<br>{% endpre %}
 
-* A `noselect` tag that can renders HTML content passed to it unselectable,
-  and generates a <code>$</code> prompt if no content is provided.
+    * {% pre This is a label %}<br>Contents of pre tag<br>{% endpre %}
+  * `number` &ndash; Number the lines
+  * `shell` &ndash; Equivalent to `label='Shell'`
+  * `style` &ndash; Apply inline CSS styles
 
-  ```html
-  {% pre %}
-  {% noselect [optional text string, defaults to $]%}Command
-  {% noselect unselectable output goes here %}
-  {% endpre %}
-  ```
+The generated &lt;pre>&lt;/pre> tag has an `data-lt-active="false"` attribute, so
+[LanguageTool](https://forum.languagetool.org/t/avoid-spell-check-on-certain-html-inputs-manually/3944)
+does not check the spelling or grammar of the contents.
 
-* An `exec` tag that executes shell commands and incorporates the command and its output into the content of the `pre` tag.
-  Environment variables are evaluated,
-  output data is escaped, whitespace is condensed, and wrapped in the same `unselectable` class as does `unselectable`.
 
-  ```html
-  {% exec [Options] [shell command] %}
-  ```
+### `Noselect`
+
+A `noselect` tag renders HTML content passed to it unselectable,
+and generates a <code>$</code> prompt if no content is provided.
 
-  `Options` are:
+```html
+{% pre %}
+{% noselect [optional text string, defaults to $]%}Command
+{% noselect unselectable output goes here %}
+{% endpre %}
+```
 
-    - `cd="relative/or/absolute/directory"` - Change to specified directory before executing shell command.
-      Environment variables in the directory path will be expanded.
-    - `die_if_nonzero` – Set `false` to treat non-zero return codes as non-fatal.
-      Instead of terminating Jekyll with an error message,
-      the message will be displayed as an error by the Jekyll logger,
-      and a red message will appear in place of the result on the web page.
-    - `die_if_error` – Set `false` to treat exceptions generated by this plugin as non-fatal.
-      Instead of terminating Jekyll with an error message, the message will be displayed as an error by the Jekyll logger.
-    - `no_escape` – Do not HTML escape the result of running the shell command.
-    - `no_stderr` - Discard STDERR output.
-      This is helpful for suppressing annoying `groff` error messages that are emitted when the `exec` subcommand runs `man`.
-      Use it like this:
+### `Exec`
 
-      ```html
-      {% pre copyButton dedent shell %}
-      {% noselect %}{% exec no_stderr man netplan %}
-      {% endpre %}
-      ```
+An `exec` tag executes shell commands and incorporates the command and its output into the content of the `pre` tag.
+Environment variables are evaluated,
+output data is escaped, whitespace is condensed, and wrapped in the same `unselectable` class as does `unselectable`.
 
-    - `no_strip` – Do not remove leading and trailing whitespace from the result.
-    - `wrapper_class` class applied to outer `div`.
-    - `wrapper_style` style applied to outer `div`.
+```html
+{% exec [Options] [shell command] %}
+```
+
+`Options` are:
+
+* `cd="relative/or/absolute/directory"` - Change to specified directory before executing shell command.
+  Environment variables in the directory path will be expanded.
+* `die_if_nonzero` – Set `false` to treat non-zero return codes as non-fatal.
+  Instead of terminating Jekyll with an error message,
+  the message will be displayed as an error by the Jekyll logger,
+  and a red message will appear in place of the result on the web page.
+* `die_if_error` – Set `false` to treat exceptions generated by this plugin as non-fatal.
+  Instead of terminating Jekyll with an error message, the message will be displayed as an error by the Jekyll logger.
+* `no_escape` – Do not HTML escape the result of running the shell command.
+* `no_stderr` - Discard STDERR output.
+  This is helpful for suppressing annoying `groff` error messages that are emitted when the `exec` subcommand runs `man`.
+  Use it like this:
+
+  ```html
+  {% pre copyButton dedent shell %}
+  {% noselect %}{% exec no_stderr man netplan %}
+  {% endpre %}
+  ```
+
+* `no_strip` – Do not remove leading and trailing whitespace from the result.
+* `wrapper_class` class applied to outer `div`.
+* `wrapper_style` style applied to outer `div`.
 
 
 ## Keyword Options
@@ -192,6 +202,8 @@ More information is available on
 
 ## Installation
 
+### Gem
+
 Add this line to your application's Gemfile, within the `jekyll_plugins` group:
 
 ```ruby
@@ -207,6 +219,37 @@ $ bundle
 ```
 
 
+### CSS and Assets
+
+Copy assets and CSS from the demo/ directory of the jekyll_pre GitHub project.
+
+* Copy `demo/assets/images/clippy.svg` to a directory of the same name in your Jekyll project.
+* Copy `demo/assets/css/jekyll_plugin_support.css` to your Jekyll project assets directory.
+* Copy `demo/assets/css/shared_include_pre.css` to your Jekyll project assets directory.
+* Copy `demo/assets/css/jekyll_pre.css` to your Jekyll project assets directory.
+* Incorporate the CSS stylesheets into the appropriate layout in your Jekyll project:
+
+```html
+{% assign nowMillis = site.time | date: '%s' %}
+<link rel="stylesheet" href="{{ '/assets/css/jekyll_plugin_support.css?v=' | append: nowMillis }}" type="text/css">
+<link rel="stylesheet" href="{{ '/assets/css/shared_include_pre.css?v=' | append: nowMillis }}" type="text/css">
+<link rel="stylesheet" href="{{ '/assets/css/jekyll_pre.css?v=' | append: nowMillis }}" type="text/css">
+```
+
+
+### JavaScript
+
+Copy `demo/assets/js/clipboard.min.js` from the `jekyll_flexible_include_plugin` GitHub project
+to your Jekyll project’s JavaScript directory.
+
+Modify the Jekyll layout or selected pages to load the JavaScript.
+You can load it from your project, as shown below, or from a CDN.
+
+```html
+<script defer src="/assets/js/clipboard.min.js"></script>
+```
+
+
 ## Usage
 
 The following examples are rendered on

data/lib/exec_tag.rb

@@ -1,4 +1,5 @@
 require 'jekyll_plugin_support'
+require 'open3'
 require 'rack/utils'
 require_relative 'jekyll_pre/version'
 

data/lib/jekyll_pre/version.rb

@@ -1,3 +1,3 @@
 module JekyllPreVersion
-  VERSION = '1.4.6'.freeze
+  VERSION = '1.4.8'.freeze
 end

data/lib/pre_tag_block.rb

@@ -56,6 +56,7 @@ module JekyllPreModule
       @dark             = ' dark' if option 'dark'
       @dedent           = option 'dedent'
       @highlight        = option 'highlight'
+      @id               = option 'id'
       @make_copy_button = option 'copyButton'
       @number_lines     = option 'number'
       @style            = option 'style'
@@ -106,7 +107,7 @@ module JekyllPreModule
       pre_content = "#{copy_button}#{content}"
       attribution = @helper.attribute if @helper.attribution
       <<~END_OUTPUT
-        <div class="jekyll_pre#{@wrapper_class}" #{@wrapper_style}>
+        <div class="jekyll_pre#{@wrapper_class}" #{@wrapper_style}#{" id='#{@id}'" if @id}>
         #{@label}
         <pre data-lt-active='false' class='#{classes}'#{@style} id='#{pre_id}'>#{pre_content}</pre>
         #{attribution}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_pre
 version: !ruby/object:Gem::Version
-  version: 1.4.6
+  version: 1.4.8
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-26 00:00:00.000000000 Z
+date: 2024-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -104,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.17
 signing_key:
 specification_version: 4
 summary: Jekyll tags pre and noselect, for HTML <pre/> tag, prompts and unselectable