Class Nanoc3::Site
In: lib/nanoc3/base/site.rb
Parent: Object

The in-memory representation of a nanoc site. It holds references to the following site data:

In addition, each site has a {config} hash which stores the site configuration.

A site also has several helper classes:

The physical representation of a {Nanoc3::Site} is usually a directory that contains a configuration file, site data, a rakefile, a rules file, etc. The way site data is stored depends on the data source.

Methods

Constants

DEFAULT_DATA_SOURCE_CONFIG = { :type => 'filesystem_unified', :items_root => '/', :layouts_root => '/', :config => {}   The default configuration for a data source. A data source‘s configuration overrides these options.
DEFAULT_CONFIG = { :text_extensions => %w( css erb haml htm html js less markdown md php rb sass txt xhtml xml ), :output_dir => 'output', :data_sources => [ {} ], :index_filenames => [ 'index.html' ], :enable_output_diff => false   The default configuration for a site. A site‘s configuration overrides these options: when a {Nanoc3::Site} is created with a configuration that lacks some options, the default value will be taken from `DEFAULT_CONFIG`.

Attributes

config  [R]  The site configuration. The configuration has the following keys:
  • `text_extensions` ({Array<String>}) - A list of file extensions that will cause nanoc to threat the file as textual instead of binary. When the data source finds a content file with an extension that is included in this list, it will be marked as textual.
  • `output_dir` ({String}) - The directory to which compiled items will be written. This path is relative to the current working directory, but can also be an absolute path.
  • `data_sources` ({Array<Hash>}) - A list of data sources for this site. See below for documentation on the structure of this list. By default, there is only one data source of the filesystem type mounted at `/`.
  • `index_filenames` ({Array<String>}) - A list of filenames that will be stripped off full item paths to create cleaner URLs. For example, `/about/` will be used instead of `/about/index.html`). The default value should be okay in most cases.
  • `enable_output_diff` ({Boolean}) - True when diffs should be generated for the compiled content of this site; false otherwise.

The list of data sources consists of hashes with the following keys:

  • `:type` ({String}) - The type of data source, i.e. its identifier.
  • `:items_root` ({String}) - The prefix that should be given to all items returned by the {items} method (comparable to mount points for filesystems in Unix-ish OSes).
  • `:layouts_root` ({String}) - The prefix that should be given to all layouts returned by the {layouts} method (comparable to mount points for filesystems in Unix-ish OSes).
  • `:config` ({Hash}) - A hash containing the configuration for this data source. nanoc itself does not use this hash. This is especially useful for online data sources; for example, a Twitter data source would need the username of the account from which to fetch tweets.

@return [Hash] The site configuration

config_mtime  [R]  @return [Time] The timestamp when the site configuration was last modified
preprocessor  [RW]  @return [Proc] The code block that will be executed after all data is loaded but before the site is compiled
rules_mtime  [R]  @return [Time] The timestamp when the rules were last modified

Public Class methods

Creates a site object for the site specified by the given `dir_or_config_hash` argument.

@param [Hash, String] dir_or_config_hash If a string, contains the path to the site directory; if a hash, contains the site configuration.

Public Instance methods

Returns this site’s code snippets.

@return [Array<Nanoc3::CodeSnippet>] The list of code snippets in this site

@raise [Nanoc3::Errors::DataNotYetAvailable] if the site data hasn’t been loaded yet (call {load_data} to load the site data)

Returns the compiler for this site. Will create a new compiler if none exists yet.

@return [Nanoc3::Compiler] The compiler for this site

Returns the data sources for this site. Will create a new data source if none exists yet.

@return [Array<Nanoc3::DataSource>] The list of data sources for this site

@raise [Nanoc3::Errors::UnknownDataSource] if the site configuration specifies an unknown data source

Returns this site’s items.

@return [Array<Nanoc3::Item>] The list of items in this site

@raise [Nanoc3::Errors::DataNotYetAvailable] if the site data hasn’t been loaded yet (call {load_data} to load the site data)

Returns this site’s layouts.

@return [Array<Nanoc3::Layouts>] The list of layout in this site

@raise [Nanoc3::Errors::DataNotYetAvailable] if the site data hasn’t been loaded yet (call {load_data} to load the site data)

Loads the site data. This will query the {Nanoc3::DataSource} associated with the site and fetch all site data. The site data is cached, so calling this method will not have any effect the second time, unless the `force` parameter is true.

@param [Boolean] force If true, will force load the site data even if it has been loaded before, to circumvent caching issues

@return [void]

[Validate]