jekyll_kramdown 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a796724c93743f8cea36b528f0db8b74f9f30ca6e35a1df8bbfc9c92cba199c7
+  data.tar.gz: db263da0a59b4e92e25aade787d317dcb755df5518ad9fe39932019a0b2089f1
+SHA512:
+  metadata.gz: 53ccc64fec3660aef6914c5a7702a386706cc967d8be71545aacad22593b9dd253987ab96c2fc6d475125e3596e0d517ba49e51b2b31e8200e6ac3ec1129cbad
+  data.tar.gz: ac774f381cd4ea8e36fe88e5c022575ef66fe8121b33cf1ee40304e70474f5cc61495bd461ffd8f29de9a842adbab8799f85e94c785eaa9625690c2fe7122b55

data/.rubocop.yml

@@ -0,0 +1,75 @@
+plugins:
+  # - rubocop-jekyll
+  - rubocop-md
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  Exclude:
+    - binstub/**/*
+    - exe/**/*
+    - vendor/**/*
+    - Gemfile*
+  NewCops: enable
+
+Gemspec/DeprecatedAttributeAssignment:
+  Enabled: false
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+
+Layout/LineLength:
+  Max: 150
+
+Lint/NonDeterministicRequireOrder:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 35
+
+Metrics/BlockLength:
+  Exclude:
+    - jekyll_kramdown.gemspec
+  Max: 30
+
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+Metrics/MethodLength:
+  Max: 40
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Max: 15
+
+Naming/FileName:
+  Exclude:
+    - Rakefile
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+RSpec/SpecFilePathFormat:
+  IgnoreMethods: true
+
+RSpec/ExampleLength:
+  Max: 30
+
+RSpec/MultipleExpectations:
+  Max: 15

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Change Log
+
+## 0.1.0
+
+* Initial release.

data/README.md

@@ -0,0 +1,148 @@
+# `Jekyll_kramdown` [![Gem Version](https://badge.fury.io/rb/jekyll_kramdown.svg)](https://badge.fury.io/rb/jekyll_kramdown)
+
+Defines a `kramdown` block tag that processes
+[Kramdown](https://kramdown.gettalong.org/) (a flavor of Markdown) embedded in
+HTML files.
+
+This plugin uses the facilities of the
+[`kramdown`](https://kramdown.gettalong.org) plugin, which can be relatively slow.
+
+
+## Installation
+
+Add the following to your Jekyll website's `Gemfile`:
+
+```ruby
+group :jekyll_plugins do
+  gem 'jekyll_kramdown'
+end
+```
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+## Options
+
+### Invocation options
+
+The available options for the `kramdown` block tag are:
+
+- `class` Wrap the output in a div with this class
+- `no_auto_ids` Do not generate `id` tags
+- `hard_wrap` Enable GitHub wrapping default
+- `input=GFM` Specify flavor of markdown (case sensitive)
+- `math_engine=katex` Specify math engine (case senstitive)
+- `maxOneScreenHigh` Wrap the output in a div with class maxOneScreenHigh
+- `style='padding: 1em;'` Wrap the output in a div with this style
+- `syntax_highlighter=rouge` Specify highligher (case sensitive)
+
+Here they are all used together:
+
+```html
+{% kramdown no_auto_ids hard_wrap maxOneScreenHigh table-container
+  input=GFM
+  math_engine=katex
+  syntax_highlighter=rouge %}
+## Subheading here
+
+- This is a perfectly good point
+- YAP (yet another point)
+
+{% href label='This link was generated by a Jekyll Support plugin.'
+          url='https://www.mslinn.com/jekyll_plugins' %}
+{% endkramdown %}
+```
+
+The above example shows the
+[`jekyll_href` tag plugin](https://www.mslinn.com/jekyll_plugins/jekyll_href.html)
+being used within kramdown text, which was embedded in an HTML page.
+
+
+### Document Options
+
+[Kramdown options can be specified in the content](https://kramdown.gettalong.org/options.html)
+to some degree and with some fussing.
+
+## Usage
+
+Add the following in any HTML file within a Jekyll project:
+
+```html
+{% kramdown %}
+## Heading
+
+Some text
+
+- option 1
+- option 2
+{% endkramdown %}
+```
+
+Modify `_config.yaml` to set kramdown options:
+
+```yaml
+kramdown:
+  input: GFM
+  hard_wrap: false
+markdown: kramdown
+```
+
+
+## Development
+
+After checking out this git repository, install dependencies by typing:
+
+```shell
+$ bin/setup
+```
+
+You should do the above before running Visual Studio Code.
+
+
+### Run the Tests
+
+```shell
+$ bundle exec rake test
+```
+
+
+### Interactive Session
+
+The following will allow you to experiment:
+
+```shell
+$ bin/console
+```
+
+
+### Local Installation
+
+To install this gem onto your local machine, type:
+
+```shell
+$ bundle exec rake install
+```
+
+
+### To Release A New Version
+
+To create a git tag for the new version, push git commits and tags,
+and push the new version of the gem to the Gem server, type:
+
+```shell
+$ bundle exec rake release
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome at https://github.com/mlinn/jekyll_kramdown.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,40 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+desc 'Bump patch version'
+task :patch do
+  system 'gem bump --tag'
+end
+
+desc 'Bump minor version'
+task :minor do
+  system 'gem bump --version minor --tag'
+end
+
+desc 'Bump major version'
+task :major do
+  system 'gem bump --version major --tag'
+end
+
+task publish: [:build] do
+  $VERBOSE = nil
+  load 'jekyll_kramdown/version.rb'
+  system "gem push pkg/jekyll_kramdown-#{JekyllKramdown::VERSION}.gem"
+end
+
+desc 'Bump patch version, create git tag, build the gem and release to geminabox (default)'
+task release_patch: %i[test patch publish]
+
+desc 'Bump minor version, create git tag, build the gem and release to geminabox'
+task release_minor: %i[test minor publish]
+
+desc 'Bump major version, create git tag, build the gem and release to geminabox'
+task release_major: %i[test major publish]
+
+task default: :test

data/jekyll_kramdown.gemspec

@@ -0,0 +1,40 @@
+require_relative 'lib/jekyll_kramdown/version'
+
+Gem::Specification.new do |spec|
+  host = 'https://github.com/mslinn/jekyll_kramdown'
+
+  spec.authors               = ['Mike Slinn']
+  spec.description           = <<~END_DESC
+    Write a longer description of the gem.
+    Use as many lines as you like.
+  END_DESC
+  spec.email                 = ['mslinn@mslinn.com']
+  spec.files                 = Dir['.rubocop.yml', 'LICENSE.*', 'Rakefile', '{lib,spec}/**/*', '*.gemspec', '*.md']
+  spec.homepage              = host
+  spec.license               = 'MIT'
+  spec.metadata = {
+    'allowed_push_host' => 'https://rubygems.org',
+    'bug_tracker_uri'   => "#{host}/issues",
+    'changelog_uri'     => "#{host}/CHANGELOG.md",
+    'homepage_uri'      => spec.homepage,
+    'source_code_uri'   => host,
+  }
+  spec.name                 = 'jekyll_kramdown'
+  spec.platform             = Gem::Platform::RUBY
+  spec.post_install_message = <<~END_MESSAGE
+
+    Thanks for installing #{spec.name}!
+
+  END_MESSAGE
+  spec.require_paths         = ['lib']
+  spec.required_ruby_version = '>= 3.1.0'
+  spec.summary               = 'Write summary of what the gem is for'
+  spec.version               = JekyllKramdown::VERSION
+
+  spec.add_dependency 'jekyll', '>= 4.4.0'
+  spec.add_dependency 'jekyll_draft'
+  spec.add_dependency 'jekyll_plugin_support', '>= 3.1.1'
+  spec.add_dependency 'kramdown'
+  spec.add_dependency 'kramdown-math-katex'
+  spec.add_dependency 'kramdown-parser-gfm'
+end

data/lib/jekyll_kramdown/version.rb

@@ -0,0 +1,3 @@
+module JekyllKramdown
+  VERSION = '0.1.0'.freeze unless defined? VERSION
+end

data/lib/jekyll_kramdown.rb

@@ -0,0 +1,10 @@
+def require_directory(dir)
+  Dir[File.join(dir, '*.rb')]&.sort&.each do |file|
+    require file unless file == __FILE__
+  end
+end
+
+require 'jekyll'
+# require 'jekyll_plugin_logger'
+require 'jekyll_plugin_support'
+require_directory __dir__

data/lib/jekyll_kramdown_module.rb

@@ -0,0 +1,24 @@
+# See https://mslinn.com/jekyll/10700-designing-for-testability.html
+module JekyllKramdownModule
+  def self.markdownify(
+    markdown_text,
+    auto_ids: true,
+    hard_wrap: false,
+    input: 'GFM',
+    math_engine: 'katex',
+    syntax_highlighter: nil
+  )
+    require 'kramdown'
+    require 'kramdown-parser-gfm'
+    require 'kramdown-math-katex'
+
+    Kramdown::Document.new(
+      markdown_text,
+      auto_ids:           auto_ids,
+      hard_wrap:          hard_wrap,
+      input:              input,
+      math_engine:        math_engine,
+      syntax_highlighter: syntax_highlighter
+    )
+  end
+end

data/lib/kramdown_class.rb

@@ -0,0 +1,67 @@
+require 'jekyll'
+require 'jekyll_plugin_support'
+require 'helper/jekyll_plugin_helper'
+require_relative 'jekyll_kramdown_module'
+require_relative 'jekyll_kramdown/version'
+
+# See https://www.mslinn.com/jekyll/10200-jekyll-plugin-background.html
+# See https://www.mslinn.com/jekyll/10400-jekyll-plugin-template-collection.html
+#
+# @example Heading for this example
+#   {% kramdown %}
+#     Content here
+#   {% endkramdown %}
+#
+# The Jekyll log level defaults to :info, which means all the Jekyll.logger statements below will not generate output.
+# You can control the log level when you start Jekyll.
+# To set the log level to :debug, write an entry into _config.yml, like this:
+# plugin_loggers:
+#   Kramdown: debug
+#
+module JekyllKramdown
+  JekyllKramdownError = ::JekyllSupport.define_error unless const_defined?(:JekyllKramdownError)
+
+  PLUGIN_NAME = 'kramdown'.freeze unless defined? PLUGIN_NAME
+
+  # This class implements the Jekyll block tag functionality
+  class Kramdown < JekyllSupport::JekyllBlock
+    # Defines class methods, see https://mslinn.com/jekyll/10700-designing-for-testability.html:
+    extend JekyllKramdownModule
+
+    VERSION = JekyllKramdown::VERSION
+
+    # @return [string] markup to be rendered on web page
+    def render_impl(content)
+      @klass = @helper.parameter_specified?('class')
+      @no_auto_ids        = @helper.parameter_specified?('no_auto_ids') || false
+      @hard_wrap          = @helper.parameter_specified?('hard_wrap')    || false
+      @input              = @helper.parameter_specified?('input')        || 'GFM'
+      @math_engine        = @helper.parameter_specified?('math_engine')  || 'katex'
+      @maxOneScreenHigh   = @helper.parameter_specified?('maxOneScreenHigh')
+      @style              = @helper.parameter_specified?('style')
+      @syntax_highlighter = @helper.parameter_specified?('syntax_highlighter')
+
+      kramdown_doc = JekyllKramdownModule.markdownify(
+        content,
+        auto_ids:           !@no_auto_ids,
+        hard_wrap:          @hard_wrap,
+        input:              @input,
+        math_engine:        @math_engine,
+        syntax_highlighter: @syntax_highlighter
+      )
+      html = kramdown_doc.to_html
+      @klass = " class='#{@klass}'" if @klass
+      @style = " style='#{@style}'" if @style
+      if @maxOneScreenHigh
+        "<div#{@klass}#{@style}><div class='maxOneScreenHigh'>#{html}</div></div>"
+      else
+        @klass || @style ? "<div#{@klass}#{@style}>#{html}</div>" : html
+      end
+    rescue StandardError => e
+      @logger.error { "#{self.class} died with a #{e.full_message}" }
+      exit 3
+    end
+
+    ::JekyllSupport::JekyllPluginHelper.register(self, PLUGIN_NAME)
+  end
+end

data/spec/jekyll_kramdown/jekyll_kramdown_module_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+require_relative '../lib/jekyll_kramdown'
+
+RSpec.describe JekyllKramdownModule do
+  extend described_class # Define class methods from JekyllKramdownModule
+
+  let(:logger) do
+    PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
+  end
+
+  let(:parse_context) { TestParseContext.new } # Mock, may not be desired
+
+  it 'has a test' do
+    expect(true).to be_true
+  end
+end

data/spec/jekyll_kramdown_spec.rb

@@ -0,0 +1,15 @@
+require 'rspec/expectations'
+require 'rspec/match_ignoring_whitespace'
+
+require_relative 'spec_helper'
+require_relative '../lib/jekyll_kramdown'
+
+class JekyllKramdownTest
+  RSpec.describe JekyllKramdown do
+    it 'tests does something' do
+      actual = 1
+      expected = 1
+      expect(actual).to eq(expected)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,81 @@
+require 'jekyll'
+require 'jekyll_plugin_logger'
+require 'liquid'
+require 'fileutils'
+require 'yaml'
+require_relative '../lib/jekyll_kramdown'
+
+RSpec.configure do |config|
+  config.filter_run :focus
+  # config.order = 'random'
+  config.run_all_when_everything_filtered = true
+  config.filter_run_when_matching focus: true
+
+  # See https://relishapp.com/rspec/rspec-core/docs/command-line/only-failures
+  config.example_status_persistence_file_path = '../spec/status_persistence.txt'
+end
+
+
+# None of the following is required if mocking Jekyll internal data structures is not required
+
+Registers = Struct.new(:page, :site)
+
+# Mock for Collections
+class Collections
+  def values
+    []
+  end
+end
+
+# Mock for Site
+class SiteMock
+  attr_reader :config
+
+  def initialize
+    @config = YAML.safe_load_file(File.read('../demo/_config.yml'))
+    @config['env'] = { 'JEKYLL_ENV' => 'development' }
+  end
+
+  def collections
+    Collections.new
+  end
+end
+
+class TestLiquidContext < Liquid::Context
+  def initialize
+    super
+
+    page = {
+      'content'     => 'blah blah',
+      'description' => 'Jekyll plugin support demo',
+      'dir'         => '/',
+      'excerpt'     => nil,
+      'layout'      => 'default',
+      'name'        => 'index.html',
+      'path'        => 'index.html',
+      'title'       => 'Welcome',
+      'url'         => '/',
+    }
+
+    @content = 'Interior of the tag'
+    @registers = Registers.new(
+      page,
+      SiteMock.new
+    )
+  end
+end
+
+# Mock for Liquid::ParseContent
+class TestParseContext < Liquid::ParseContext
+  attr_reader :line_number, :registers
+
+  def initialize
+    super
+    @line_number = 123
+
+    @registers = Registers.new(
+      { 'path' => 'path/to/page.html' },
+      SiteMock.new
+    )
+  end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_kramdown
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike Slinn
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.4.0
+- !ruby/object:Gem::Dependency
+  name: jekyll_draft
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jekyll_plugin_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: kramdown-math-katex
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: kramdown-parser-gfm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  Write a longer description of the gem.
+  Use as many lines as you like.
+email:
+- mslinn@mslinn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- README.md
+- Rakefile
+- jekyll_kramdown.gemspec
+- lib/jekyll_kramdown.rb
+- lib/jekyll_kramdown/version.rb
+- lib/jekyll_kramdown_module.rb
+- lib/kramdown_class.rb
+- spec/jekyll_kramdown/jekyll_kramdown_module_spec.rb
+- spec/jekyll_kramdown_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mslinn/jekyll_kramdown
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/mslinn/jekyll_kramdown/issues
+  changelog_uri: https://github.com/mslinn/jekyll_kramdown/CHANGELOG.md
+  homepage_uri: https://github.com/mslinn/jekyll_kramdown
+  source_code_uri: https://github.com/mslinn/jekyll_kramdown
+post_install_message: |2+
+
+  Thanks for installing jekyll_kramdown!
+
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.2
+specification_version: 4
+summary: Write summary of what the gem is for
+test_files: []
+...