jekyll-slides 0.1.0

data/lib/jekyll/slides/slide_metadata.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Slides
+    class SlideMetadata
+      LAYOUTS = %w[title statement content code code-left code-right split-code code-result].freeze
+      BACKGROUNDS = %w[plain gradient grid spotlight].freeze
+      KEYS = %w[layout class background].freeze
+
+      attr_reader :layout, :background, :custom_class, :content, :values
+
+      def self.parse(content, index: 0, warning: nil, components: nil)
+        new(content, index: index, warning: warning).parse(components: components)
+      end
+
+      def initialize(content, index: 0, warning: nil)
+        @original_content = content.to_s
+        @index = index
+        @warning = warning
+        @content, @values = extract_comment(@original_content)
+        @background = @values["background"] || "plain"
+        @custom_class = @values["class"].to_s.strip
+      end
+
+      def parse(components: nil)
+        components ||= ComponentRenderer.new(warning: @warning).render_document(@content).components
+        @layout = @values["layout"] || inferred_layout(components)
+
+        unless LAYOUTS.include?(@layout)
+          Support.warn(@warning, "Invalid slide layout #{@layout.inspect}; falling back to automatic layout")
+          @layout = inferred_layout(components)
+        end
+        unless BACKGROUNDS.include?(@background)
+          Support.warn(@warning, "Invalid slide background #{@background.inspect}; falling back to plain")
+          @background = "plain"
+        end
+        self
+      end
+
+      private
+
+      def extract_comment(body)
+        match = body.match(/\A[ \t]*(<!--(.*?)-->)[ \t]*(?:\r?\n)?/m)
+        return [body, {}] unless match
+
+        values = {}
+        lines = match[2].to_s.lines.map(&:strip).reject(&:empty?)
+        parsed = lines.map { |line| line.match(/\A(\w[\w-]*)\s*:\s*(.*?)\z/) }
+        return [body, {}] unless parsed.all?
+        return [body, {}] unless parsed.any? { |match_data| KEYS.include?(match_data[1]) }
+
+        parsed.each do |match_data|
+          key = match_data[1]
+          if KEYS.include?(key)
+            values[key] = match_data[2].strip
+          else
+            Support.warn(@warning, "Unknown slide metadata key #{key.inspect}; ignoring")
+          end
+        end
+        [body[match.end(0)..].to_s, values]
+      end
+
+      def inferred_layout(components)
+        return "code-result" if components == %i[editor terminal]
+
+        editors = components.count(:editor)
+        terminals = components.count(:terminal)
+        return "split-code" if editors > 1 && components.all? { |component| component == :editor }
+        return "code" if editors.positive? || terminals.positive?
+        return "title" if @index.to_i.zero?
+
+        statement_content?(@content) ? "statement" : "content"
+      end
+
+      def statement_content?(body)
+        chunks = body.strip.split(/\n\s*\n/)
+        return false unless (1..2).cover?(chunks.length)
+        return false unless chunks.first.match?(/\A\s*\#{1,6}\s+.+\z/m)
+        return true if chunks.length == 1
+
+        chunks.last.lines.none? { |line| line.match?(/\A\s*(?:[#>*-]|```|~~~)/) }
+      end
+    end
+  end
+end

data/lib/jekyll/slides/slide_renderer.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Slides
+    class SlideRenderer
+      def initialize(warning: nil, component_renderer: nil, options: {})
+        @warning = warning
+        @component_renderer = component_renderer || ComponentRenderer.new(warning: warning, options: options)
+      end
+
+      def render(markdown)
+        PresentationParser.new(markdown).parse.each_with_index.map do |source, index|
+          metadata = SlideMetadata.new(source, index: index, warning: @warning)
+          rendered = @component_renderer.render_document(
+            metadata.content,
+            id_prefix: "slide-#{index + 1}-"
+          )
+          metadata.parse(components: rendered.components)
+          fragments = rendered.fragments
+          body = composition(metadata.layout, fragments)
+          classes = ["slide", "layout-#{metadata.layout}", "bg-#{metadata.background}"]
+          classes.concat(metadata.custom_class.split(/\s+/)) unless metadata.custom_class.empty?
+          attrs = %(class="#{Support.escape(classes.join(' '))}" id="slide-#{index + 1}" data-slide="#{index + 1}" aria-label="Slide #{index + 1}")
+          %(<section #{attrs}><div class="slide-content">#{body}</div></section>)
+        end.join
+      end
+
+      private
+
+      def composition(layout, fragments)
+        prose = fragments.select { |kind, _html, _metadata| kind == :prose }.map { |_kind, html, _metadata| html }.join
+        visual = fragments.select { |kind, _html, _metadata| kind == :visual }.map { |_kind, html, _metadata| html }.join
+        case layout
+        when "split-code"
+          split_panes(fragments)
+        when "code-result"
+          %(<div class="prose">#{prose}</div><div class="stack">#{visual}</div>)
+        when "code-left"
+          %(<div class="panes"><div class="pane visual">#{visual}</div><div class="pane prose">#{prose}</div></div>)
+        when "code-right"
+          %(<div class="panes"><div class="pane prose">#{prose}</div><div class="pane visual">#{visual}</div></div>)
+        when "code"
+          code_layout(prose, visual)
+        else
+          fragments.map { |_kind, html, _metadata| html }.then { |body| %(<div class="prose">#{body.join}</div>) }
+        end
+      end
+
+      def code_layout(prose, visual)
+        prose_html = prose.empty? ? "" : %(<div class="prose">#{prose}</div>)
+        %(#{prose_html}<div class="visual">#{visual}</div>)
+      end
+
+      def split_panes(fragments)
+        visual_index = fragments.index { |kind, _| kind == :visual }
+        return %(<div class="prose">#{fragments.map { |_kind, html, _metadata| html }.join}</div>) unless visual_index
+
+        panes = []
+        leading = fragments[0...visual_index]
+        h1_intro = leading.length == 1 && leading.first[2][:heading_level] == 1
+        global = if h1_intro
+                   leading.map { |_kind, html, _metadata| html }.join
+                 elsif leading.length > 1
+                   leading[0...-1].map { |_kind, html, _metadata| html }.join
+                 end
+        pending = if h1_intro
+                    +""
+                  elsif leading.length > 1
+                    leading.last[1].dup
+                  else
+                    leading.map { |_kind, html, _metadata| html }.join
+                  end
+        fragments[visual_index..].each do |kind, html, _metadata|
+          if kind == :visual
+            panes << %(<div class="pane">#{pending}#{html}</div>)
+            pending = +""
+          else
+            pending << html
+          end
+        end
+        if pending.empty?
+          # no trailing prose
+        elsif panes.empty?
+          panes << %(<div class="pane">#{pending}</div>)
+        else
+          panes[-1] = panes[-1].sub(%r{</div>\z}, "#{pending}</div>")
+        end
+        prefix = global && !global.empty? ? %(<div class="prose">#{global}</div>) : ""
+        panes.empty? ? prefix : %(#{prefix}<div class="panes">#{panes.join}</div>)
+      end
+    end
+  end
+end

data/lib/jekyll/slides/support.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "cgi/escape"
+
+module Jekyll
+  module Slides
+    module Support
+      module_function
+
+      def warn(warning, message)
+        return unless warning
+
+        if warning.respond_to?(:call)
+          warning.call(message)
+        elsif warning.respond_to?(:warn)
+          warning.warn(message)
+        end
+      end
+
+      def escape(value)
+        CGI.escapeHTML(value.to_s)
+      end
+    end
+  end
+end

data/lib/jekyll/slides/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Slides
+    VERSION = "0.1.0"
+  end
+end

data/lib/jekyll/slides.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require "rouge"
+
+module Jekyll
+  # Markdown presentations for Jekyll, with editor and terminal components.
+  #
+  # Add +jekyll-slides+ to the site's plugins and choose the +presentation+
+  # layout on a Markdown page. Separate slides with +---+ outside fenced code blocks.
+  # The plugin supplies layouts, includes, styles, scripts, and offline fonts
+  # while preserving the site's theme and local overrides.
+  #
+  # Configure defaults under +slides:+ in _config.yml, or use front matter on
+  # individual decks. Themes are +midnight+, +minimal-light+, +minimal-dark+,
+  # and +ruby+. The supported aspect ratio is 16:9; quote this value in YAML.
+  #
+  # Jekyll runs Liquid before rendering each slide as one Markdown document.
+  # Jekyll::Slides::Presentation also renders slide HTML directly when Jekyll integration
+  # is not needed; it does not evaluate Liquid or wrap the presentation layout.
+  module Slides
+    ROOT = File.expand_path("../..", __dir__)
+    LAYOUT_NAME = "presentation"
+  end
+end
+
+require_relative "slides/version"
+require_relative "slides/support"
+require_relative "slides/presentation_parser"
+require_relative "slides/slide_metadata"
+require_relative "slides/range_parser"
+require_relative "slides/rouge_renderer"
+require_relative "slides/component_renderer"
+require_relative "slides/slide_renderer"
+require_relative "slides/presentation"
+require_relative "slides/renderer"
+require_relative "slides/layout"
+require_relative "slides/assets"
+require_relative "slides/jekyll_integration"

data/lib/jekyll-slides.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "jekyll/slides"

data/llm.txt

@@ -0,0 +1,50 @@
+# Module Jekyll::Slides <a id="module-Jekyll-Slides"></a>
+
+|  |  |
+| --- | --- |
+| **Defined in** | lib/jekyll/slides.rb, lib/jekyll/slides/assets.rb, lib/jekyll/slides/layout.rb, lib/jekyll/slides/support.rb, lib/jekyll/slides/version.rb, lib/jekyll/slides/renderer.rb, lib/jekyll/slides/presentation.rb, lib/jekyll/slides/range_parser.rb, lib/jekyll/slides/rouge_renderer.rb, lib/jekyll/slides/slide_metadata.rb, lib/jekyll/slides/slide_renderer.rb, lib/jekyll/slides/component_renderer.rb, lib/jekyll/slides/jekyll_integration.rb, lib/jekyll/slides/presentation_parser.rb |
+
+Markdown presentations for Jekyll, with editor and terminal components.
+
+Add <code>jekyll-slides</code> to the site's plugins and choose the
+`presentation` layout on a Markdown page. Separate slides with
+<code>---</code> outside fenced code blocks. The plugin supplies layouts,
+includes, styles, scripts, and offline fonts while preserving the site's theme
+and local overrides.
+
+Configure defaults under <code>slides:</code> in _config.yml, or use front
+matter on individual decks. Themes are `midnight`, <code>minimal-light</code>,
+<code>minimal-dark</code>, and `ruby`. The supported aspect ratio is 16:9;
+quote this value in YAML.
+
+Jekyll runs Liquid before rendering each slide as one Markdown document.
+Jekyll::Slides::Presentation also renders slide HTML directly when Jekyll
+integration is not needed; it does not evaluate Liquid or wrap the
+presentation layout.
+
+## Constants
+### `LAYOUT_NAME` <a id="constant-LAYOUT_NAME"></a> <a id="LAYOUT_NAME-constant"></a>
+Not documented.
+
+### `ROOT` <a id="constant-ROOT"></a> <a id="ROOT-constant"></a>
+Not documented.
+
+### `VERSION` <a id="constant-VERSION"></a> <a id="VERSION-constant"></a>
+Not documented.
+
+# Documentation
+
+- [Slides/Assets/SiteAssetFile.md](doc/Jekyll/Slides/Assets/SiteAssetFile.md)
+- [Slides/Assets.md](doc/Jekyll/Slides/Assets.md)
+- [Slides/ComponentRenderer/RenderedDocument.md](doc/Jekyll/Slides/ComponentRenderer/RenderedDocument.md)
+- [Slides/ComponentRenderer.md](doc/Jekyll/Slides/ComponentRenderer.md)
+- [Slides/JekyllIntegration.md](doc/Jekyll/Slides/JekyllIntegration.md)
+- [Slides/Layout.md](doc/Jekyll/Slides/Layout.md)
+- [Slides/Presentation.md](doc/Jekyll/Slides/Presentation.md)
+- [Slides/PresentationParser.md](doc/Jekyll/Slides/PresentationParser.md)
+- [Slides/RangeParser.md](doc/Jekyll/Slides/RangeParser.md)
+- [Slides/Renderer.md](doc/Jekyll/Slides/Renderer.md)
+- [Slides/RougeRenderer.md](doc/Jekyll/Slides/RougeRenderer.md)
+- [Slides/SlideMetadata.md](doc/Jekyll/Slides/SlideMetadata.md)
+- [Slides/SlideRenderer.md](doc/Jekyll/Slides/SlideRenderer.md)
+- [Slides/Support.md](doc/Jekyll/Slides/Support.md)

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-slides
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lucian Ghinda
+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.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: kramdown-parser-gfm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+description: A Jekyll plugin for turning Markdown into accessible, responsive slide
+  presentations with code and terminal components.
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- _includes/slides/controls.html
+- _includes/slides/overview.html
+- _includes/slides/progress.html
+- _layouts/presentation.html
+- assets/css/presentation.css
+- assets/fonts/OFL-atkinson-hyperlegible-mono.txt
+- assets/fonts/OFL-atkinson-hyperlegible-next.txt
+- assets/fonts/README.md
+- assets/fonts/atkinson-hyperlegible-mono-italic.woff2
+- assets/fonts/atkinson-hyperlegible-mono.woff2
+- assets/fonts/atkinson-hyperlegible-next-italic.woff2
+- assets/fonts/atkinson-hyperlegible-next.woff2
+- assets/js/presentation.js
+- doc/CHANGELOG.md
+- doc/Jekyll.md
+- doc/Jekyll/Slides.md
+- doc/Jekyll/Slides/Assets.md
+- doc/Jekyll/Slides/Assets/SiteAssetFile.md
+- doc/Jekyll/Slides/ComponentRenderer.md
+- doc/Jekyll/Slides/ComponentRenderer/RenderedDocument.md
+- doc/Jekyll/Slides/JekyllIntegration.md
+- doc/Jekyll/Slides/Layout.md
+- doc/Jekyll/Slides/Presentation.md
+- doc/Jekyll/Slides/PresentationParser.md
+- doc/Jekyll/Slides/RangeParser.md
+- doc/Jekyll/Slides/Renderer.md
+- doc/Jekyll/Slides/RougeRenderer.md
+- doc/Jekyll/Slides/SlideMetadata.md
+- doc/Jekyll/Slides/SlideRenderer.md
+- doc/Jekyll/Slides/Support.md
+- doc/README.md
+- doc/index.csv
+- lib/jekyll-slides.rb
+- lib/jekyll/slides.rb
+- lib/jekyll/slides/assets.rb
+- lib/jekyll/slides/component_renderer.rb
+- lib/jekyll/slides/jekyll_integration.rb
+- lib/jekyll/slides/layout.rb
+- lib/jekyll/slides/presentation.rb
+- lib/jekyll/slides/presentation_parser.rb
+- lib/jekyll/slides/range_parser.rb
+- lib/jekyll/slides/renderer.rb
+- lib/jekyll/slides/rouge_renderer.rb
+- lib/jekyll/slides/slide_metadata.rb
+- lib/jekyll/slides/slide_renderer.rb
+- lib/jekyll/slides/support.rb
+- lib/jekyll/slides/version.rb
+- llm.txt
+homepage: https://github.com/lucianghinda/jekyll-slides
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/lucianghinda/jekyll-slides
+  source_code_uri: https://github.com/lucianghinda/jekyll-slides/tree/main
+  bug_tracker_uri: https://github.com/lucianghinda/jekyll-slides/issues
+  changelog_uri: https://github.com/lucianghinda/jekyll-slides/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.11
+specification_version: 4
+summary: Polished technical presentations from Markdown for Jekyll
+test_files: []