Module: Quiver

Defined in:

lib/quiver.rb,
lib/quiver/cell.rb,
lib/quiver/note.rb,
lib/quiver/root.rb,
lib/quiver/config.rb,
lib/quiver/notebook.rb,
lib/quiver_note/version.rb,
lib/quiver/adapter/local.rb,
lib/quiver/adapter/dropbox.rb

Defined Under Namespace

Modules: Adapter Classes: Cell, Configuration, Note, Notebook, Root

Constant Summary

VERSION =

"0.0.5"

Class Method Summary

• .config ⇒ Object

  Global settings for Quiver.

• .configure {|@config ||= Quiver::Configuration.new| ... } ⇒ Object

  Quiver.configure do |config| config.markdown_renderer = ->(markdown){ MyRenderer.render(markdown) } end.

• .dropbox(path, access_key) ⇒ Object
• .local(path) ⇒ Object

Class Method Details

.config ⇒ Object

Global settings for Quiver

# File 'lib/quiver/config.rb', line 12

def self.config
  @config
end

.configure {|@config ||= Quiver::Configuration.new| ... } ⇒ Object

Quiver.configure do |config|

  config.markdown_renderer = ->(markdown){ MyRenderer.render(markdown) }
end

Yields:

• (@config ||= Quiver::Configuration.new)

# File 'lib/quiver/config.rb', line 7

def self.configure(&block)
  yield @config ||= Quiver::Configuration.new
end

.dropbox(path, access_key) ⇒ Object

# File 'lib/quiver.rb', line 6

def self.dropbox(path, access_key)
  adapter = Quiver::Adapter::Dropbox.new(Pathname.new(path), access_key)
  Quiver::Root.new(adapter)
end

.local(path) ⇒ Object

# File 'lib/quiver.rb', line 2

def self.local(path)
  adapter = Quiver::Adapter::Local.new(Pathname.new(path))
  Quiver::Root.new(adapter)
end