Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
14 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,40 +4,41 @@ 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. | ||
Please be sure to have "Guard":http://github.com/guard/guard installed before continue. | ||
|
||
Install the gem: | ||
|
||
gem install guard-gimli | ||
bc. gem install guard-gimli | ||
|
||
Add guard definition to your Guardfile by running this command: | ||
|
||
guard init gimli | ||
bc. guard init gimli | ||
|
||
h2. Usage | ||
|
||
Please read {Guard usage doc}[http://github.com/guard/guard#readme] and {gimli usage doc}[http://github.com/walle/gimli#readme] | ||
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. | ||
Please read "Guard doc":http://github.com/guard/guard#readme 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 | ||
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 | ||
|
||
LiveReload guard have 1 option that you can set like this: | ||
This comment has been minimized.
Sorry, something went wrong.
This comment has been minimized.
Sorry, something went wrong.
walle
Author
Owner
|
||
|
||
guard 'gimli', :outputdir => 'build' do | ||
... | ||
end | ||
bc. guard 'gimli', :outputdir => 'build' do | ||
... | ||
end | ||
|
||
Available options: | ||
|
||
:outputdir => 'build' # default nil ie. working dir | ||
bc. :outputdir => 'build' # default nil ie. directory of file | ||
|
||
See {gimli doc}[http://github.com/walle/gimli#readme] for more info. | ||
See "gimli doc":http://github.com/walle/gimli#readme for more info. | ||
|
LiveReload? :) För övrigt mycket tufft plugin!