Module: Trifle::Docs

Defined in:
lib/trifle/docs.rb,
lib/trifle/docs/app.rb,
lib/trifle/docs/engine.rb,
lib/trifle/docs/version.rb,
lib/trifle/docs/harvester.rb,
lib/trifle/docs/helper/tree.rb,
lib/trifle/docs/configuration.rb,
lib/trifle/docs/harvester/file.rb,
lib/trifle/docs/operations/meta.rb,
lib/trifle/docs/harvester/markdown.rb,
lib/trifle/docs/operations/content.rb,
lib/trifle/docs/operations/sitemap.rb,
lib/trifle/docs/operations/collection.rb

Defined Under Namespace

Modules: Harvester, Helper, Operations Classes: App, Configuration, Engine, Error, PageController

Constant Summary collapse

VERSION = 
'0.3.1'

Class Method Summary collapse

Class Method Details

.collection(url:, config: nil) ⇒ Object 



43
44
45
46
47
 
# File 'lib/trifle/docs.rb', line 43

def self.collection(url:, config: nil)
  Trifle::Docs::Operations::Collection.new(
    url: url, config: config
  ).perform
end

.configure {|default| ... } ⇒ Object

Yields:



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

def self.configure
  yield(default)

  default
end

.content(url:, config: nil) ⇒ Object 



31
32
33
34
35
 
# File 'lib/trifle/docs.rb', line 31

def self.content(url:, config: nil)
  Trifle::Docs::Operations::Content.new(
    url: url, config: config
  ).perform
end

.default ⇒ Object 



21
22
23
 
# File 'lib/trifle/docs.rb', line 21

def self.default
  @default ||= Configuration.new
end

.meta(url:, config: nil) ⇒ Object 



37
38
39
40
41
 
# File 'lib/trifle/docs.rb', line 37

def self.meta(url:, config: nil)
  Trifle::Docs::Operations::Meta.new(
    url: url, config: config
  ).perform
end

.sitemap(config: nil) ⇒ Object 



49
50
51
52
53
 
# File 'lib/trifle/docs.rb', line 49

def self.sitemap(config: nil)
  Trifle::Docs::Operations::Sitemap.new(
    config: config
  ).perform
end