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/operations/search.rb,
lib/trifle/docs/harvester/markdown.rb,
lib/trifle/docs/operations/content.rb,
lib/trifle/docs/operations/sitemap.rb,
lib/trifle/docs/helper/ai_detection.rb,
lib/trifle/docs/operations/collection.rb,
lib/trifle/docs/helper/markdown_layout.rb,
lib/trifle/docs/operations/raw_content.rb

Defined Under Namespace

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

Constant Summary collapse

VERSION = 
'0.5.0'

Class Method Summary collapse

Class Method Details

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



59
60
61
62
63
 
# File 'lib/trifle/docs.rb', line 59

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

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

Yields:



29
30
31
32
33
 
# File 'lib/trifle/docs.rb', line 29

def self.configure
  yield(default)

  default
end

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



41
42
43
44
45
 
# File 'lib/trifle/docs.rb', line 41

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

.default ⇒ Object 



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

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

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



47
48
49
50
51
 
# File 'lib/trifle/docs.rb', line 47

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

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



53
54
55
56
57
 
# File 'lib/trifle/docs.rb', line 53

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

.search(query:, scope: nil, config: nil) ⇒ Object 



35
36
37
38
39
 
# File 'lib/trifle/docs.rb', line 35

def self.search(query:, scope: nil, config: nil)
  Trifle::Docs::Operations::Search.new(
    query: query, scope: scope, config: config
  ).perform
end

.sitemap(config: nil) ⇒ Object 



65
66
67
68
69
 
# File 'lib/trifle/docs.rb', line 65

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