przn 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b95e225303285a7367884694da54d91d95b0712be8100578411ae2b51581ee39
+  data.tar.gz: a2aea20a6be5dd25d7bd4cbd9af39e1440aebb7edc66c70071770b16ce1e352c
+SHA512:
+  metadata.gz: 27846a7edb522887dc829610c2caf156a2793aaff8713aae1d12f6d1bbcb364942d3c3983aadf077a49d5929e8d269b16b6fedae5ad802aa1714ee2c35f0bde8
+  data.tar.gz: 4a9f75a34f60da321224fd41d7d2e3f527262a36f273b909d59a74154afb665e709cfaa9110ae1766394055e5889da98697e75a2a25677190e8a5dfec363ba31

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Akira Matsuda
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,156 @@
+# przn
+
+A terminal-based presentation tool written in Ruby.
+Renders Markdown slides with [Kitty text sizing protocol](https://sw.kovidgoyal.net/kitty/text-sizing-protocol/) support for beautifully scaled headings.
+
+## Installation
+
+```
+gem install przn
+```
+
+## Usage
+
+```
+przn your_slides.md
+```
+
+### PDF export
+
+```
+przn --export your_slides.md
+przn --export pdf your_slides.md
+przn --export pdf -o output.pdf your_slides.md
+```
+
+Requires a TrueType font (with `glyf` outlines) for proper rendering. Prawn does not support CFF-based fonts (most `.otf` files). Fonts are auto-detected in this order: NotoSansJP TTF, HackGen, Arial Unicode.
+
+### Key bindings
+
+| Key | Action |
+|-----|--------|
+| `→` `↓` `l` `j` `Space` | Next slide |
+| `←` `↑` `h` `k` | Previous slide |
+| `g` | First slide |
+| `G` | Last slide |
+| `q` `Ctrl-C` | Quit |
+
+## Markdown format
+
+przn's Markdown format is compatible with [Rabbit](https://rabbit-shocker.org/)'s Markdown mode.
+
+### Slide splitting
+
+Slides are separated by `#` (h1) headings.
+
+```markdown
+# Slide 1
+
+content
+
+# Slide 2
+
+more content
+```
+
+### Text formatting
+
+```markdown
+*emphasis*
+**bold**
+~~strikethrough~~
+`inline code`
+```
+
+### Lists
+
+```markdown
+* item 1
+* item 2
+  * nested item
+
+- also works as bullets
+
+1. ordered
+2. list
+```
+
+### Code blocks
+
+Fenced code blocks:
+
+````markdown
+```ruby
+puts "hello"
+```
+````
+
+Indented code blocks (4 spaces) with optional kramdown IAL:
+
+```markdown
+    def hello
+      puts "world"
+    end
+{: lang="ruby"}
+```
+
+### Block quotes
+
+```markdown
+> quoted text
+> continues here
+```
+
+### Tables
+
+```markdown
+| Header 1 | Header 2 |
+|----------|----------|
+| cell 1   | cell 2   |
+```
+
+### Definition lists
+
+```markdown
+term
+:   definition
+```
+
+### Text sizing
+
+Uses Rabbit-compatible `{::tag}` notation. Supported size names: `xx-small`, `x-small`, `small`, `large`, `x-large`, `xx-large`, `xxx-large`, `xxxx-large`, and numeric `1`-`7`.
+
+```markdown
+{::tag name="x-large"}Big text{:/tag}
+{::tag name="7"}Maximum size{:/tag}
+```
+
+On [Kitty](https://sw.kovidgoyal.net/kitty/)-compatible terminals, sized text is rendered using the OSC 66 text sizing protocol. On other terminals, the markup is silently ignored.
+
+### Alignment
+
+```markdown
+{:.center}
+centered text
+
+{:.right}
+right-aligned text
+```
+
+### Comments
+
+```markdown
+{::comment}
+This text is hidden from the presentation.
+{:/comment}
+```
+
+### Notes
+
+```markdown
+Visible text {::note}(speaker note){:/note}
+```
+
+## 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,12 @@
+# frozen_string_literal: true
+
+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
+
+task default: :test

data/default_theme.yml

@@ -0,0 +1,16 @@
+# Default przn theme
+#
+# Copy this file and pass your copy via --theme to customize.
+# All keys are optional — unspecified values fall back to these defaults.
+
+colors:
+  background: "000000"
+  foreground: "ffffff"
+  heading:              # falls back to foreground
+  code_bg: "313244"
+  dim: "6c7086"
+  inline_code: "a6e3a1"
+
+font:
+  family:               # auto-detect
+  size: 18              # base font size in pt for PDF export

data/exe/przn

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/przn'
+
+require 'optparse'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: przn [options] <presentation.md>"
+  opts.on('--export [FORMAT]', 'Export to a format (default: pdf)') { |v|
+    if v && v.end_with?('.md')
+      ARGV.unshift(v)
+      options[:export] = 'pdf'
+    else
+      options[:export] = v || 'pdf'
+    end
+  }
+  opts.on('-o', '--output FILE', 'Output file path for export') { |v| options[:output] = v }
+  opts.on('--theme FILE', 'Theme file (YAML)') { |v| options[:theme] = v }
+  opts.on('--generate-theme', 'Generate theme.yml in current directory') { options[:generate_theme] = true }
+end.parse!
+
+if options[:generate_theme]
+  content = File.read(Przn::Theme::DEFAULT_PATH).sub(/\A(#[^\n]*\n)+\n/, '')
+  File.write('theme.yml', content)
+  puts "Generated: theme.yml"
+  exit
+end
+
+file = ARGV[0]
+unless file
+  $stderr.puts "Usage: przn [options] <presentation.md>"
+  exit 1
+end
+
+theme = options[:theme] ? Przn::Theme.load(options[:theme]) : nil
+
+if options[:export] == 'pdf'
+  output = options[:output] || File.basename(file, File.extname(file)) + '.pdf'
+  Przn.export_pdf(file, output, theme: theme)
+else
+  Przn.start(file, theme: theme).run
+end

data/lib/przn/controller.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Przn
+  class Controller
+    def initialize(presentation, terminal, renderer)
+      @presentation = presentation
+      @terminal = terminal
+      @renderer = renderer
+    end
+
+    def run
+      @terminal.enter_alt_screen
+      @terminal.hide_cursor
+      render_current
+
+      @terminal.raw do
+        loop do
+          case read_key
+          when :right, :down, 'l', 'j', ' '
+            @presentation.next_slide
+            render_current
+          when :left, :up, 'h', 'k'
+            @presentation.prev_slide
+            render_current
+          when 'g'
+            @presentation.first_slide!
+            render_current
+          when 'G'
+            @presentation.last_slide!
+            render_current
+          when 'q', "\x03"
+            break
+          end
+        end
+      end
+    ensure
+      @terminal.show_cursor
+      @terminal.leave_alt_screen
+    end
+
+    private
+
+    def render_current
+      @renderer.render(
+        @presentation.current_slide,
+        current: @presentation.current,
+        total: @presentation.total
+      )
+    end
+
+    def read_key
+      c = $stdin.getc
+      return nil unless c
+
+      if c == "\e"
+        seq = $stdin.read_nonblock(2)
+        case seq
+        when '[A' then :up
+        when '[B' then :down
+        when '[C' then :right
+        when '[D' then :left
+        when '[H' then :home
+        when '[F' then :end
+        else :escape
+        end
+      else
+        c
+      end
+    rescue IO::WaitReadable
+      :escape
+    end
+  end
+end

data/lib/przn/image_util.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Przn
+  module ImageUtil
+    module_function
+
+    def image_size(path)
+      return nil unless File.exist?(path)
+
+      File.open(path, 'rb') do |f|
+        header = f.read(8)
+        return nil unless header && header.size >= 4
+
+        # PNG
+        if header.b == "\x89PNG\r\n\x1a\n".b
+          f.seek(16)
+          w = f.read(4)&.unpack1('N')
+          h = f.read(4)&.unpack1('N')
+          return [w, h] if w && h
+        end
+
+        # JPEG
+        f.seek(0)
+        if header.b[0..1] == "\xFF\xD8".b
+          f.seek(2)
+          loop do
+            marker = f.read(2)
+            break unless marker && marker.size == 2 && marker.getbyte(0) == 0xFF
+            type = marker.getbyte(1)
+            if [0xC0, 0xC1, 0xC2].include?(type)
+              f.read(3)
+              h = f.read(2)&.unpack1('n')
+              w = f.read(2)&.unpack1('n')
+              return [w, h] if w && h
+            end
+            len = f.read(2)&.unpack1('n')
+            break unless len && len >= 2
+            f.seek(len - 2, IO::SEEK_CUR)
+          end
+        end
+
+        # GIF
+        f.seek(0)
+        sig = f.read(6)
+        if sig&.start_with?("GIF8")
+          w = f.read(2)&.unpack1('v')
+          h = f.read(2)&.unpack1('v')
+          return [w, h] if w && h
+        end
+      end
+      nil
+    rescue
+      nil
+    end
+
+    # Display image using kitten icat with --place for positioning
+    def kitty_icat(path, cols:, rows:, x:, y:)
+      args = ['kitten', 'icat', '--transfer-mode', 'stream',
+              '--place', "#{cols}x#{rows}@#{x}x#{y}",
+              File.expand_path(path)]
+      IO.popen(args, 'r', err: File::NULL) { |io| io.read }
+    end
+
+    def kitty_terminal?
+      ENV['TERM'] == 'xterm-kitty' || ENV['TERM_PROGRAM'] == 'kitty'
+    end
+
+    # Sixel via img2sixel
+    def sixel_available?
+      @sixel_available = system('command -v img2sixel > /dev/null 2>&1') if @sixel_available.nil?
+      @sixel_available
+    end
+
+    def sixel_encode(path, width: nil, height: nil)
+      return nil unless sixel_available?
+      return nil unless File.exist?(path)
+
+      args = ['img2sixel']
+      args += ['-w', width.to_s] if width
+      args += ['-h', height.to_s] if height
+      args << path
+      IO.popen(args, 'r', err: File::NULL) { |io| io.read }
+    end
+  end
+end

data/lib/przn/kitty_text.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Przn
+  module KittyText
+    HEADING_SCALES = {
+      1 => 4,
+      2 => 3,
+      3 => 2,
+    }.freeze
+
+    module_function
+
+    def sized(text, s:, h: nil, v: nil)
+      params = +"s=#{s}"
+      params << ":h=#{h}" if h
+      params << ":v=#{v}" if v
+      "\e]66;#{params};#{text}\a"
+    end
+
+    def heading(text, level:)
+      scale = HEADING_SCALES[level]
+      return text unless scale
+
+      sized(text, s: scale, h: 1)
+    end
+  end
+end