Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Ruby
Branch: master
Failed to load latest commit information.
lib/guard
spec Refactor command
.gitignore Add pkg/ to gitignore
.travis.yml
Gemfile Change to rr as mocking framework
Guardfile Initial commit
LICENSE Initial commit
README.textile Update README
Rakefile Initial commit
guard-gimli.gemspec Fix indentation

README.textile

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.

Something went wrong with that request. Please try again.