przn 0.5.0 → 0.6.0

data/sample/sample.md

@@ -1,69 +1,310 @@
-# przn
+# przn {counter=hide}
 
 A terminal presentation tool written in Ruby
 
-# Features
+# Slide format
 
-- **Markdown** based slides
-- *Kitty text sizing* protocol support
-- Simple keyboard navigation
+Every <color=cyan>`# h1`</color> starts a new slide.
 
-# Code Blocks
+Below the heading you can write **bold**, *italic*, `inline code`, ~~strikethrough~~, and the usual markdown.
+
+# Lists
+
+Unordered, ordered, and nested:
+
+- pick a fruit
+- or a vegetable
+  - leafy ones too
+- something else
+
+1. first
+2. second
+3. third
+
+# Code blocks
 
 ```ruby
-puts "Hello from przn!"
+class Slide
+  attr_reader :title, :body
+end
 ```
 
-# Inline Formatting
+```python
+def fib(n):
+    return n if n < 2 else fib(n-1) + fib(n-2)
+```
 
-This is **bold**, this is *italic*, and this is `inline code`.
+# Code blocks — per-line stepping `{lines=…|…}`
 
-> This is a blockquote
+```ruby {lines=1|2-3|4-5}
+class Slide
+  attr_reader :title, :body
+  def initialize(title:, body: "")
+    @title, @body = title, body
+  end
+end
+```
 
-# Lists
+Press Space → the highlight walks: line 1, then 2-3, then 4-5.
+
+# Block quotes
+
+> Code is read more often than it is written.
+
+> Tables, lists, and the rest of standard markdown render normally.
+
+# Tables
+
+| Language | Year | Designer |
+|----------|------|----------|
+| Ruby     | 1995 | Matz |
+| Python   | 1991 | Guido |
+| Lisp     | 1958 | McCarthy |
+
+# Definition lists
+
+term
+: definition for the term
+
+another term
+: another definition
+
+# Text sizing — `<size=N>`
+
+<size=xx-small>xx-small</size> <size=x-small>x-small</size> <size=small>small</size> <size=large>large</size>
+
+<size=x-large>x-large</size> text
+
+<size=xx-large>xx-large</size> text
+
+<size=xxx-large>xxx-large</size> text
+
+<size=xxxx-large>biggest</size> text
+
+# Color — `<color=NAME>`
+
+<color=red>red</color>, <color=green>green</color>, <color=yellow>yellow</color>, <color=blue>blue</color>, <color=magenta>magenta</color>, <color=cyan>cyan</color>
+
+Plus 6-digit hex: <color=ff5555>tomato-ish</color>, <color=50fa7b>mint</color>, <color=8be9fd>sky</color>
+
+# Font — `<font>`
+
+<font face="Helvetica Neue" size="x-large">Helvetica Neue</font>
+
+<font face="Menlo" color="green" size="large">monospace in green</font>
+
+<font face="Georgia" size="xx-large" color="cyan">all three</font> at once
+
+# Alignment — `<center>` / `<right>`
+
+<center>centered line</center>
+
+<right>right-aligned line</right>
+
+The bare paragraph stays left-aligned for contrast.
+
+# Slide background — `<bg>`
+
+<bg color="#1a1a2e"/>
+
+A `<bg>` directive applies for this slide only. The next slide reverts.
+
+# Background — gradient
+
+<bg from="#1a1a2e" to="#16213e" angle="90"/>
+
+`<bg from="..." to="..." angle="..."/>` ships a linear gradient (Echoes' OSC 7772).
+
+# Background — image
+
+<bg image="ruby.png"/>
+
+`<bg image="ruby.png"/>` uses the Kitty Graphics Protocol at `z: -1` so text layers on top.
+
+# Image — flow (intrinsic size)
+
+<img src="ruby.png"/>
+
+# Image — relative_height="70"
+
+<img src="ruby.png" relative_height="70"/>
+
+# Image — width="N%"
+
+<img src="ruby.png" width="40%"/>
+
+# Image — absolute position
+
+<img src="ruby.png" x="5c"  y="3c"  relative_height="40"/>
+<img src="ruby.png" x="50%" y="50%" relative_height="40"/>
+
+# Image — alignment keywords
+
+<img src="ruby.png" x="left"   y="top"    relative_height="20"/>
+<img src="ruby.png" x="center" y="top"    relative_height="20"/>
+<img src="ruby.png" x="right"  y="top"    relative_height="20"/>
+<img src="ruby.png" x="left"   y="bottom" relative_height="20"/>
+<img src="ruby.png" x="center" y="bottom" relative_height="20"/>
+<img src="ruby.png" x="right"  y="bottom" relative_height="20"/>
+
+# Absolute-position text — `<at>`
+
+<at x="5"  y="5">top-left ish</at>
+<at x="40" y="15"><size=x-large>BIG</size></at>
+<at x="60" y="20"><color=red>warn</color></at>
+<at x="50%" y="50%"><font face="Georgia" size="xx-large" color="cyan">dead center</font></at>
+
+# `<at>` — alignment keywords
+
+<at x="left"   y="top">top-left</at>
+<at x="center" y="top">top-center</at>
+<at x="right"  y="top">top-right</at>
+<at x="left"   y="center">middle-left</at>
+<at x="center" y="center"><font face="Georgia" size="xx-large">middle</font></at>
+<at x="right"  y="center">middle-right</at>
+<at x="left"   y="bottom">bottom-left</at>
+<at x="center" y="bottom">bottom-center</at>
+<at x="right"  y="bottom">bottom-right</at>
+
+# Shapes and Lines
+
+<rect x="10" y="5"  width="20" height="6" rx="1" fill="tomato"/>
+<circle cx="60%" cy="40%" r="6" fill="gold"/>
+<ellipse cx="85%" cy="40%" rx="8" ry="4" fill="cyan"/>
+<line x1="10" y1="20" x2="70" y2="20" stroke="white" stroke-width="0.3"/>
+<arrow x1="10" y1="24" x2="70" y2="24" stroke="cyan" stroke-width="0.4"/>
+<polyline points="10,26 25,28 40,26 55,28 70,26" stroke="lime" stroke-width="0.4" fill="none"/>
+<polygon points="50%,3 60%,15 50%,20 40%,15" fill="orange"/>
+<path d="M 30 27 C 45 23 55 31 70 27" stroke="white" stroke-width="0.4" fill="none"/>
+
+# Two columns {layout=two-column}
+
+left side
+
+- bullet A
+- bullet B
+
+<slot/>
+
+right side
+
+- bullet C
+- bullet D
+
+# Takahashi method {layout=takahashi}
+
+たかはし
+
+# Title only {layout=title-only}
+
+# Comments
+
+<!-- this comment is hidden; the slide renders only the prose below -->
+
+Comments use `<!-- ... -->` (single-line or multi-line) and never appear on the rendered slide.
+
+# Speaker notes
+
+The next sentence has a hidden side-strip note. <note>this never appears on the audience screen</note> Everything around the note still shows.
+
+The note is visible in `--present` mode on the presenter pane.
+
+# Step builds — `<wait/>`
+
+A `<wait/>` on its own line splits the slide into steps.
+
+<wait/>
+
+Press Space again — the next group reveals.
+
+<wait/>
+
+And again — the layout doesn't reflow, the hidden text was already reserved.
+
+# Step builds — inline `<wait/>` in a list
+
+- foo
+- <wait/>bar
+- <wait/>baz
+
+The same step boundary, scoped to a single list item — the bullets stay in one list (numbering and indentation intact), and each `<wait/>` walks one item in.
+
+# Slide transition — fade _(Echoes only)_ {transition=fade}
+
+The h1 IAL `{transition=fade}` opts this slide into a fade transition. Press → to leave: the text smoothly fades to nothing before the next slide arrives.
+
+# …and fades back in {transition=fade}
+
+This slide also opts in, so the previous one fades out AND this one fades in. Either side can opt in independently — leave one off and that half snaps.
+
+`theme.transition.duration` (ms) controls the per-half speed; default 200ms.
+
+# Fragment animations — directional fades
+
+<at x="10" y="40%" fragment="fade-up">fade-up</at>
+<at x="30" y="40%" fragment="fade-down">fade-down</at>
+<at x="50" y="40%" fragment="fade-left">fade-left</at>
+<at x="70" y="40%" fragment="fade-right">fade-right</at>
+
+Each `<at fragment="…">` adds a step boundary — press → to walk them in, one by one. The text slides into its declared spot while fading from alpha 0 to 1.
+
+# Cross-slide ref — `<ref id=…/>`
+
+<at id="quote" x="center" y="40%">🤘 Fall to your knees and repent if you please</at>
+
+Declared once above. The next slide ref's it in place — and again, moved.
+
+# …same quote, re-used
+
+<ref id="quote"/>
+<ref id="quote" y="80%"/>
+
+The text comes from the previous slide; the second `<ref>` overrides `y=`.
+
+# Composite reuse — `<group>`
+
+<group id="callout">
+<rect x="30%" y="50%" width="40%" height="6" fill="tomato" opacity="0.3" stroke="tomato"/>
+<at x="center" y="55%">Watch this part →</at>
+</group>
+
+A rectangle plus a caption, bundled. Press Space →
 
-- First item
-- Second item
-- Third item
+# …re-used as one bundle
 
-1. Ordered one
-2. Ordered two
-3. Ordered three
+<ref id="callout"/>
 
-# Custom Styling
+Both the rect and the caption land in the same place — declared once.
 
-{::tag name="xx-large"}BIG text{:/tag}
+# Actions — `<action>`
 
-{::tag name="x-large"}large text{:/tag}
+<arrow id="arrow" x1="15" y1="27" x2="15" y2="20" stroke="cyan" stroke-width="0.5"/>
 
-{::tag name="large"}large text{:/tag}
+A vertical arrow points up, well below the text. Press Space to step it across.
 
-normal and {::tag name="red"}red text{:/tag} mixed
+<wait/>
 
-# Image (PNG)
+<action target="arrow" x1="50" x2="50" duration="500ms"/>
 
-![](doge.png){:relative_height="70"}
+<wait/>
 
-# Image (JPG)
+<action target="arrow" x1="85" x2="85" duration="500ms"/>
 
-![](doge.jpg){:relative_height="70"}
+# Fade — `<action opacity=…>` _(Echoes only)_
 
-# Image (XML form)
+<at id="msg-out" x="center" y="40%">This message will fade out.</at>
+<at id="msg-in"  x="center" y="60%" opacity="0">…and this one fades in.</at>
 
-<img src="doge.png" relative_height="70"/>
+Press Space to step through the fade.
 
-# Image (absolute position)
+<wait/>
 
-<img src="doge.png" x="5"   y="3"   relative_height="40"/>
-<img src="doge.png" x="50%" y="50%" relative_height="40"/>
+<action target="msg-out" opacity="0" duration="1s"/>
 
-# Absolute-position text
+<wait/>
 
-<at x="10" y="10">top-left ish</at>
-<at x="40" y="15"><size=3>BIG</size></at>
-<at x="80" y="25"><color=red>warn</color></at>
-<at x="50%" y="50%">dead center</at>
+<action target="msg-in" opacity="1" duration="1s"/>
 
-# Thank You!
+# Thank you
 
-That's all! Enjoy!
+That's all — enjoy.

data/sample/shapes.md

@@ -0,0 +1,55 @@
+# Shapes Examples
+
+# Lines (1)
+<line x1="10" y1="6" x2="70" y2="6" stroke="white" stroke-width="0.3"/>
+
+# Lines (2)
+<line x1="10" y1="10" x2="70" y2="14" stroke="cyan" stroke-width="0.4"/>
+
+# Lines (3)
+<line x1="10" y1="20" x2="70" y2="16" stroke="purple" stroke-width="0.5"/>
+
+# Rectangles (1)
+<rect x="10" y="5" width="20" height="6" fill="tomato"/>
+
+# Rectangles (2)
+<rect x="35" y="5" width="20" height="6" rx="1" fill="cyan"/>
+
+# Rectangles (3)
+<rect x="60" y="5" width="15" height="6" fill="none" stroke="gold" stroke-width="0.4"/>
+
+# Circles (1)
+<circle cx="20%" cy="50%" r="5" fill="tomato"/>
+
+# Circles (2)
+<circle cx="50%" cy="50%" r="6" fill="none" stroke="lavender" stroke-width="0.5"/>
+
+# Ellipses
+<ellipse cx="80%" cy="50%" rx="8" ry="4" fill="gold"/>
+
+# Polylines
+<polyline points="10,8 25,18 40,8 55,18 70,8" stroke="lime" stroke-width="0.4" fill="none"/>
+
+# Polygons
+<polygon points="50%,3 60%,15 50%,20 40%,15" fill="gold"/>
+
+# Arrows
+<arrow x1="10" y1="6"  x2="70" y2="6"  stroke="cyan"   stroke-width="0.4"/>
+<arrow x1="10" y1="12" x2="70" y2="18" stroke="yellow" stroke-width="0.5"/>
+<arrow x1="40" y1="22" x2="40" y2="6"  stroke="red"    stroke-width="0.4"/>
+
+# Paths
+
+<path d="M 10 5 L 70 5 L 40 25 Z" fill="cyan" stroke="white" stroke-width="0.3"/>
+
+# Path — cubic Bezier curve
+
+<path d="M 10 20 C 25 5 55 5 70 20" stroke="orange" stroke-width="0.4" fill="none"/>
+
+# Mixed composition
+<line x1="5" y1="50%" x2="75" y2="50%" stroke="white" stroke-width="0.3"/>
+<circle cx="20" cy="50%" r="2" fill="tomato"/>
+<circle cx="40" cy="50%" r="2" fill="cyan"/>
+<circle cx="60" cy="50%" r="2" fill="gold"/>
+
+A timeline of three events.

metadata

@@ -1,103 +1,117 @@
 --- !ruby/object:Gem::Specification
 name: przn
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
-  - Akira Matsuda
+- Akira Matsuda
 bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
-  - !ruby/object:Gem::Dependency
-    name: prawn
-    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: hexapdf
-    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: A terminal-based presentation tool that renders Markdown slides with Kitty text sizing protocol support for beautifully scaled headers
+- !ruby/object:Gem::Dependency
+  name: prawn
+  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: hexapdf
+  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: rouge
+  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: A terminal-based presentation tool that renders Markdown slides with
+  Kitty text sizing protocol support for beautifully scaled headers
 email:
-  - ronnie@dio.jp
+- ronnie@dio.jp
 executables:
-  - przn
+- przn
 extensions: []
 extra_rdoc_files: []
 files:
-  - LICENSE.txt
-  - README.md
-  - Rakefile
-  - default_theme.yml
-  - exe/przn
-  - lib/przn.rb
-  - lib/przn/audience_link.rb
-  - lib/przn/controller.rb
-  - lib/przn/echoes_client.rb
-  - lib/przn/image_util.rb
-  - lib/przn/kitty_text.rb
-  - lib/przn/parser.rb
-  - lib/przn/prawn_pdf_exporter.rb
-  - lib/przn/presentation.rb
-  - lib/przn/presenter_renderer.rb
-  - lib/przn/renderer.rb
-  - lib/przn/screenshot_pdf_exporter.rb
-  - lib/przn/slide.rb
-  - lib/przn/terminal.rb
-  - lib/przn/theme.rb
-  - lib/przn/version.rb
-  - sample/doge.jpg
-  - sample/doge.png
-  - sample/sample.md
-  - sig/przn.rbs
-homepage: "https://github.com/amatsuda/przn"
+- LICENSE.txt
+- README.md
+- Rakefile
+- default_theme.yml
+- exe/przn
+- lib/przn.rb
+- lib/przn/audience_link.rb
+- lib/przn/code_highlighter.rb
+- lib/przn/controller.rb
+- lib/przn/echoes_client.rb
+- lib/przn/file_watcher.rb
+- lib/przn/image_util.rb
+- lib/przn/kitty_text.rb
+- lib/przn/mermaid_renderer.rb
+- lib/przn/parser.rb
+- lib/przn/prawn_pdf_exporter.rb
+- lib/przn/presentation.rb
+- lib/przn/presenter_renderer.rb
+- lib/przn/renderer.rb
+- lib/przn/screenshot_pdf_exporter.rb
+- lib/przn/slide.rb
+- lib/przn/terminal.rb
+- lib/przn/theme.rb
+- lib/przn/version.rb
+- sample/ruby-logo-LICENSE
+- sample/ruby.jpg
+- sample/ruby.png
+- sample/sample.md
+- sample/shapes.md
+- sig/przn.rbs
+homepage: https://github.com/amatsuda/przn
 licenses:
-  - MIT
+- MIT
 metadata:
-  allowed_push_host: "https://rubygems.org"
-  source_code_uri: "https://github.com/amatsuda/przn"
-  homepage_uri: "https://github.com/amatsuda/przn"
+  allowed_push_host: https://rubygems.org
+  source_code_uri: https://github.com/amatsuda/przn
+  homepage_uri: https://github.com/amatsuda/przn
 rdoc_options: []
 require_paths:
-  - lib
+- lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-    -
-      - ">="
-      - !ruby/object:Gem::Version
-        version: "0"
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-    -
-      - ">="
-      - !ruby/object:Gem::Version
-        version: "0"
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-rubygems_version: 4.1.0.dev
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Terminal presentation tool
 test_files: []