module Flammarion
This is the main namespace for Flammarion
. You really need an {Engraving} to do anything useful. If you just want to test that everything is setup correctly, you can use {Flammarion.about}. You can find samples and screenshots at github.com/zach-capalbo/flammarion and some examples at github.com/zach-capalbo/flammarion/tree/master/examples @see Engraving
@see Writeable
@see github.com/zach-capalbo/flammarion @see github.com/zach-capalbo/flammarion/tree/master/examples
Constants
- VERSION
Public Class Methods
about()
click to toggle source
Pops up a little about box.
# File lib/flammarion/about.rb, line 3 def self.about f = Engraving.new(close_on_exit:true) f.title "Flammarion #{VERSION}" readme = "#{File.absolute_path(File.dirname(__FILE__))}/../../Readme.md" license = "#{File.absolute_path(File.dirname(__FILE__))}/../../LICENSE" f.markdown(File.read(readme)) f.break f.markdown(File.read(license)) f.wait_until_closed end
Private Class Methods
development_mode=(turnOn)
click to toggle source
# File lib/flammarion/revelator.rb, line 141 def self.development_mode=(turnOn) raise StandardError.new("Can't turn on development mode on unix system. (Just start the middleman server, and flammarion will detect it automatically.") unless RbConfig::CONFIG["host_os"] =~ /cygwin|mswin|mingw/ ENV["FLAMMARION_DEVELOPMENT"] = "true" end
development_mode?()
click to toggle source
# File lib/flammarion/revelator.rb, line 132 def self.development_mode? return true if RbConfig::CONFIG["host_os"] =~ /cygwin|mswin|mingw/ development_mode = ENV["FLAMMARION_DEVELOPMENT"] == "true" else development_mode = system("lsof -i:#{4567}", out: '/dev/null') and File.exist?("#{File.dirname(__FILE__)}/../html/source/index.html.slim") end end