Module: Slideck

Defined in:
lib/slideck.rb,
lib/slideck/cli.rb,
lib/slideck/errors.rb,
lib/slideck/loader.rb,
lib/slideck/margin.rb,
lib/slideck/parser.rb,
lib/slideck/runner.rb,
lib/slideck/tracker.rb,
lib/slideck/version.rb,
lib/slideck/metadata.rb,
lib/slideck/renderer.rb,
lib/slideck/alignment.rb,
lib/slideck/converter.rb,
lib/slideck/presenter.rb,
lib/slideck/transformer.rb,
lib/slideck/metadata_parser.rb,
lib/slideck/metadata_wrapper.rb,
lib/slideck/metadata_defaults.rb,
lib/slideck/metadata_converter.rb

Overview

Present Markdown-powered slide decks in a terminal

Defined Under Namespace

Classes: Alignment, CLI, Converter, InvalidMetadataKeyError, Loader, Margin, Metadata, MetadataConverter, MetadataDefaults, MetadataParser, MetadataWrapper, Parser, Presenter, Renderer, Runner, Tracker, Transformer

Constant Summary collapse

Error =

Raised to signal an error condition

Class.new(StandardError)
ReadError =

Raised when unable to read slides from a location

Class.new(Error)
InvalidArgumentError =

Raised when argument is invalid

Class.new(Error)
VERSION = 
"0.1.0"

Class Method Summary collapse

Class Method Details

.run(cmd_args = ARGV, env = ENV) ⇒ void

This method returns an undefined value.

Run slides deck

Examples:

Slideck.run

Parameters:

  • cmd_args (Array<String>) (defaults to: ARGV) —

    the command arguments

  • env (Hash{String => String}) (defaults to: ENV) —

    the environment variables



25
26
27
28
29
 
# File 'lib/slideck.rb', line 25

def self.run(cmd_args = ARGV, env = ENV)
  runner = Runner.new(TTY::Screen, $stdin, $stdout, env)
  cli = CLI.new(runner, $stdout, $stderr)
  cli.start(cmd_args, env)
end