Module: Wytch

Defined in:
lib/wytch.rb,
lib/wytch/cli.rb,
lib/wytch/once.rb,
lib/wytch/page.rb,
lib/wytch/site.rb,
lib/wytch/server.rb,
lib/wytch/builder.rb,
lib/wytch/version.rb,
lib/wytch/sitemap_view.rb,
lib/wytch/content_loader.rb,
lib/wytch/sitemap_helper.rb,
lib/wytch/reload_coordinator.rb,
lib/wytch/site_code_loader_middleware.rb

Overview

Wytch is a minimal static site generator that uses Ruby for content and Phlex for views.

Examples:

Basic configuration in config.rb

Wytch.configure do |site|
  site.page_class = "MySite::Page"
  site.base_url = "https://example.com"
end

See Also:

Defined Under Namespace

Modules: SitemapHelper Classes: Builder, CLI, ContentLoader, Error, Once, Page, ReloadCoordinator, Server, Site, SiteCodeLoaderMiddleware, SitemapView

Constant Summary collapse

VERSION =

The current version of Wytch.

"0.5.0"

Class Method Summary collapse

Class Method Details

.configure {|site| ... } ⇒ Wytch::Site

Configures the global site instance.

Examples:

Wytch.configure do |site|
  site.page_class = "MySite::Page"
  site.content_dir = "pages"
end

Yields:

  • (site) —

    Configuration block

Yield Parameters:

  • site (Wytch::Site) —

    the site instance to configure

Returns:



44
45
46
47
 
# File 'lib/wytch.rb', line 44

def configure
  yield(site) if block_given?
  site
end

.reset_site! ⇒ void

This method returns an undefined value.

Resets the global site instance. Primarily used for testing.



52
53
54
 
# File 'lib/wytch.rb', line 52

def reset_site!
  @site = nil
end

.site ⇒ Wytch::Site

Returns the global site instance.

Returns:



29
30
31
 
# File 'lib/wytch.rb', line 29

def site
  @site ||= Site.new
end