Parent

Files

Class/Module Index [+]

Quicksearch

Jekyll::Command

Public Class Methods

add_build_options(c) click to toggle source

Add common options to a command for building configuration

c - the Jekyll::Command to add these options to

Returns nothing

# File lib/jekyll/command.rb, line 50
def add_build_options(c)
  c.option 'config',  '--config CONFIG_FILE[,CONFIG_FILE2,...]', Array, 'Custom configuration file'
  c.option 'future',  '--future', 'Publishes posts with a future date'
  c.option 'limit_posts', '--limit_posts MAX_POSTS', Integer, 'Limits the number of posts to parse and publish'
  c.option 'watch',   '-w', '--watch', 'Watch for changes and rebuild'
  c.option 'force_polling', '--force_polling', 'Force watch to use polling'
  c.option 'lsi',     '--lsi', 'Use LSI for improved related posts'
  c.option 'show_drafts',  '-D', '--drafts', 'Render posts in the _drafts folder'
  c.option 'unpublished', '--unpublished', 'Render posts that were marked as unpublished'
  c.option 'quiet',   '-q', '--quiet', 'Silence output.'
  c.option 'verbose', '-V', '--verbose', 'Print verbose output.'
end
configuration_from_options(options) click to toggle source

Create a full Jekyll configuration with the options passed in as overrides

options - the configuration overrides

Returns a full Jekyll configuration

# File lib/jekyll/command.rb, line 41
def configuration_from_options(options)
  Jekyll.configuration(options)
end
inherited(base) click to toggle source

Keep a list of subclasses of Jekyll::Command every time it’s inherited Called automatically.

base - the subclass

Returns nothing

# File lib/jekyll/command.rb, line 17
def inherited(base)
  subclasses << base
  super(base)
end
process_site(site) click to toggle source

Run Site#process and catch errors

site - the Jekyll::Site object

Returns nothing

# File lib/jekyll/command.rb, line 27
def process_site(site)
  site.process
rescue Jekyll::Errors::FatalException => e
  Jekyll.logger.error "ERROR:", "YOUR SITE COULD NOT BE BUILT:"
  Jekyll.logger.error "", "------------------------------------"
  Jekyll.logger.error "", e.message
  exit(1)
end
subclasses() click to toggle source

A list of subclasses of Jekyll::Command

# File lib/jekyll/command.rb, line 7
def subclasses
  @subclasses ||= []
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.