Class: SleepingKingStudios::Docs::Commands::Installation::InstallJekyll

Parent Namespace

SleepingKingStudios::Docs::Commands::Installation

Inherited Classes

Cuprum::Command > Object

Defined In

lib/sleeping_king_studios/docs/commands/installation/install_jekyll.rb

Table Of Contents

• Overview
• Constructor
• Instance Methods
  • description
  • dry_run?
  • initialize
  • name
  • repository
  • verbose?

Overview

Installs the Jekyll application.

Back To Top

Constructor

#initialize(**options) => Object

Overloads

#initialize(**options) => Object

Parameters

• options (Hash) — additional options for the command.

Options Hash (options)

• description (String) — a short description of the documented library.
• dry_run (Boolean) — if true, does not apply filesystem changes. Defaults to false.
• name (String) — the name of the documented library.
• repository (String) — the URL of the library repository.
• verbose (Boolean) — if true, prints updates to STDOUT. Defaults to true.

Returns

• (InstallJekyll) — a new instance of InstallJekyll

Back To Top

Instance Methods

#description => String

Returns

• (String) — a short description of the documented library.

#dry_run? => Boolean

Returns

• (Boolean) — if true, does not apply filesystem changes.

#name => String

Returns

• (String) — the name of the documented library.

#repository => String

Returns

• (String) — the URL of the library repository.

#verbose? => Boolean

Returns

• (Boolean) — if true, prints updates to STDOUT.

Back To Top

---

Back to Documentation | Versions | 0.2 | Reference | SleepingKingStudios | SleepingKingStudios::Docs | SleepingKingStudios::Docs::Commands | SleepingKingStudios::Docs::Commands::Installation