# guard-gimli

**Repository Path**: mirrors_guard/guard-gimli

## Basic Information

- **Project Name**: guard-gimli
- **Description**: Guard gem for gimli
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-08
- **Last Updated**: 2026-06-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

h1. guard-gimli

"!http://travis-ci.org/walle/guard-gimli.png!":http://travis-ci.org/walle/guard-gimli

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

h2. Install

Please be sure to have "Guard":http://github.com/guard/guard installed before continue.

Install the gem:

bc. gem install guard-gimli

Add guard definition to your Guardfile by running this command:

bc. guard init gimli

h2. Usage

All commands originate from the directory where the file is located
Please read "Guard usage doc":http://github.com/guard/guard#readme and "gimli usage doc":http://github.com/walle/gimli#readme

h2. Guardfile

You can adapt your markup files like you want.
Please read "Guard doc":http://github.com/guard/guard#readme for more info about Guardfile DSL.

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

h2. Options

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

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

Available options:

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

See "gimli doc":http://github.com/walle/gimli#readme for more info.