Skip to content

Latest commit

 

History

History
47 lines (27 loc) · 1.27 KB

README.textile

File metadata and controls

47 lines (27 loc) · 1.27 KB

guard-gimli

gimli guard allows to automatically convert your files when markup is changed

Install

Please be sure to have Guard installed before continue.

Install the gem:

gem install guard-gimli

Add guard definition to your Guardfile by running this command:

guard init gimli

Usage

All commands originate from the directory where the file is located
Please read Guard usage doc and gimli usage doc

Guardfile

You can adapt your markup files like you want.
Please read Guard doc for more info about Guardfile DSL.

guard 'gimli' do
  watch(%r{.+\.(md|mkdn?|mdown|markdown|textile|rdoc|org|creole|re?st(\.txt)?|asciidoc|pod|\d|(media)?wiki)})
end

Options

gimli guard have two options that you can set like this:

guard 'gimli', :outputdir => 'build', :stylesheet => 'style.css' do
  ...
end

Available options:

:outputdir => 'build'    # default nil ie. directory of file
:stylesheet => 'style.css'    # default nil ie. only the standard css

See gimli doc for more info.