mirror of
https://github.com/haml/haml.git
synced 2022-11-09 12:33:31 -05:00
Updated docs
This commit is contained in:
parent
d8a260b09b
commit
df50d35914
5 changed files with 28 additions and 19 deletions
12
CHANGELOG.md
12
CHANGELOG.md
|
@ -1,6 +1,6 @@
|
||||||
# Haml Changelog
|
# Haml Changelog
|
||||||
|
|
||||||
## 4.0.0 (Unreleased)
|
## 4.0.0
|
||||||
|
|
||||||
* The Haml exectutable now accepts an `--autoclose` option. You can now
|
* The Haml exectutable now accepts an `--autoclose` option. You can now
|
||||||
specify a list of tags that should be autoclosed
|
specify a list of tags that should be autoclosed
|
||||||
|
@ -64,7 +64,7 @@
|
||||||
with a helper method that makes adding support for other Tilt-based template
|
with a helper method that makes adding support for other Tilt-based template
|
||||||
engines trivial.
|
engines trivial.
|
||||||
|
|
||||||
As of 3.2, Haml will also ship with a "haml-contrib" gem that includes useful
|
As of 4.0, Haml will also ship with a "haml-contrib" gem that includes useful
|
||||||
but less-frequently used filters and helpers. This includes several additional
|
but less-frequently used filters and helpers. This includes several additional
|
||||||
filters such as Nokogiri, Yajl, Markaby, and others.
|
filters such as Nokogiri, Yajl, Markaby, and others.
|
||||||
|
|
||||||
|
@ -105,10 +105,16 @@
|
||||||
* Add command-line option to suppress script evaluation.
|
* Add command-line option to suppress script evaluation.
|
||||||
|
|
||||||
* It's now possible to use Rails's asset helpers inside the Sass and SCSS
|
* It's now possible to use Rails's asset helpers inside the Sass and SCSS
|
||||||
filters.
|
filters. Note that to do so, you must make sure sass-rails is loaded in
|
||||||
|
production, usually by moving it out of the assets gem group.
|
||||||
|
|
||||||
* The Haml project now uses [semantic versioning](http://semver.org/).
|
* The Haml project now uses [semantic versioning](http://semver.org/).
|
||||||
|
|
||||||
|
## 3.2.0
|
||||||
|
|
||||||
|
The Haml 3.2 series was released only as far as 3.2.0.rc.4, but then was
|
||||||
|
renamed to Haml 4.0 when the project adopted semantic versioning.
|
||||||
|
|
||||||
## 3.1.6
|
## 3.1.6
|
||||||
|
|
||||||
* In indented mode, don't reindent buffers that contain preserved tags, and
|
* In indented mode, don't reindent buffers that contain preserved tags, and
|
||||||
|
|
23
README.md
23
README.md
|
@ -129,20 +129,23 @@ on a specific area:
|
||||||
Haml supports Ruby 1.8.7 and higher, so please make sure your changes run on
|
Haml supports Ruby 1.8.7 and higher, so please make sure your changes run on
|
||||||
both 1.9 and 1.8.
|
both 1.9 and 1.8.
|
||||||
|
|
||||||
## Authors
|
## Team
|
||||||
|
|
||||||
|
### Current Maintainers
|
||||||
|
|
||||||
|
* [Norman Clarke](http://github.com/norman)
|
||||||
|
* [Matt Wildig](http://github.com/mattwildig)
|
||||||
|
* [Akira Matsuda](https://github.com/amatsuda)
|
||||||
|
|
||||||
|
### Alumni
|
||||||
|
|
||||||
Haml was created by [Hampton Catlin](http://hamptoncatlin.com), the author of
|
Haml was created by [Hampton Catlin](http://hamptoncatlin.com), the author of
|
||||||
the original implementation. However, Hampton doesn't even know his way around
|
the original implementation. Hampton is no longer involved in day-to-day coding,
|
||||||
the code anymore and now just occasionally consults on the language issues.
|
but still consults on language issues.
|
||||||
|
|
||||||
[Nathan Weizenbaum](http://nex-3.com) was for many years the primary developer
|
[Nathan Weizenbaum](http://nex-3.com) was for many years the primary developer
|
||||||
and architect of the "modern" Ruby implementation of Haml. His hard work
|
and architect of the "modern" Ruby implementation of Haml.
|
||||||
endlessly answering forum posts, fixing bugs, refactoring, finding speed
|
|
||||||
improvements, writing documentation, and implementing new features is what has
|
|
||||||
kept the project alive.
|
|
||||||
|
|
||||||
[Norman Clarke](http://github.com/norman), the author of Haml Spec and the Haml
|
|
||||||
implementation in Lua, took over as maintainer in April 2012.
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
@ -150,7 +153,7 @@ Some of Nathan's work on Haml was supported by Unspace Interactive.
|
||||||
|
|
||||||
Beyond that, the implementation is licensed under the MIT License.
|
Beyond that, the implementation is licensed under the MIT License.
|
||||||
|
|
||||||
Copyright (c) 2006-2009 Hampton Catlin and Nathan Weizenbaum
|
Copyright (c) 2006-2013 Hampton Catlin, Nathan Weizenbaum and the Haml team
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||||
this software and associated documentation files (the "Software"), to deal in
|
this software and associated documentation files (the "Software"), to deal in
|
||||||
|
|
|
@ -1131,7 +1131,7 @@ implemented using Tilt.
|
||||||
Parses the filtered text with [Maruku](https://github.com/nex3/maruku), which
|
Parses the filtered text with [Maruku](https://github.com/nex3/maruku), which
|
||||||
has some non-standard extensions to Markdown.
|
has some non-standard extensions to Markdown.
|
||||||
|
|
||||||
As of Haml 3.2, this filter is defined in [Haml
|
As of Haml 4.0, this filter is defined in [Haml
|
||||||
contrib](https://github.com/haml/haml-contrib) but is loaded automatically for
|
contrib](https://github.com/haml/haml-contrib) but is loaded automatically for
|
||||||
historical reasons. In future versions of Haml it will likely not be loaded by
|
historical reasons. In future versions of Haml it will likely not be loaded by
|
||||||
default. This filter is implemented using Tilt.
|
default. This filter is implemented using Tilt.
|
||||||
|
@ -1171,7 +1171,7 @@ SCSS syntax to produce CSS output. This filter is implemented using Tilt.
|
||||||
Parses the filtered text with [Textile](http://www.textism.com/tools/textile).
|
Parses the filtered text with [Textile](http://www.textism.com/tools/textile).
|
||||||
Only works if [RedCloth](http://redcloth.org) is installed.
|
Only works if [RedCloth](http://redcloth.org) is installed.
|
||||||
|
|
||||||
As of Haml 3.2, this filter is defined in [Haml
|
As of Haml 4.0, this filter is defined in [Haml
|
||||||
contrib](https://github.com/haml/haml-contrib) but is loaded automatically for
|
contrib](https://github.com/haml/haml-contrib) but is loaded automatically for
|
||||||
historical reasons. In future versions of Haml it will likely not be loaded by
|
historical reasons. In future versions of Haml it will likely not be loaded by
|
||||||
default. This filter is implemented using Tilt.
|
default. This filter is implemented using Tilt.
|
||||||
|
|
|
@ -34,7 +34,7 @@ module Haml
|
||||||
# @option options [String] :extend The name of a module to extend when
|
# @option options [String] :extend The name of a module to extend when
|
||||||
# defining the filter. Defaults to "Plain". This allows filters such as
|
# defining the filter. Defaults to "Plain". This allows filters such as
|
||||||
# Coffee to "inherit" from Javascript, wrapping its output in script tags.
|
# Coffee to "inherit" from Javascript, wrapping its output in script tags.
|
||||||
# @since 3.2.0
|
# @since 4.0
|
||||||
def register_tilt_filter(name, options = {})
|
def register_tilt_filter(name, options = {})
|
||||||
if constants.map(&:to_s).include?(name.to_s)
|
if constants.map(&:to_s).include?(name.to_s)
|
||||||
raise "#{name} filter already defined"
|
raise "#{name} filter already defined"
|
||||||
|
@ -63,7 +63,7 @@ module Haml
|
||||||
# to redefine a filter, Haml will raise an error. Use this method first to
|
# to redefine a filter, Haml will raise an error. Use this method first to
|
||||||
# explicitly remove the filter before redefining it.
|
# explicitly remove the filter before redefining it.
|
||||||
# @return Module The filter module that has been removed
|
# @return Module The filter module that has been removed
|
||||||
# @since 3.2.0
|
# @since 4.0
|
||||||
def remove_filter(name)
|
def remove_filter(name)
|
||||||
defined.delete name.to_s.downcase
|
defined.delete name.to_s.downcase
|
||||||
if constants.map(&:to_s).include?(name.to_s)
|
if constants.map(&:to_s).include?(name.to_s)
|
||||||
|
@ -393,7 +393,7 @@ RUBY
|
||||||
end
|
end
|
||||||
|
|
||||||
# These filters have been demoted to Haml Contrib but are still included by
|
# These filters have been demoted to Haml Contrib but are still included by
|
||||||
# default in Haml 3.2. Still, we rescue from load error if for some reason
|
# default in Haml 4.0. Still, we rescue from load error if for some reason
|
||||||
# haml-contrib is not installed.
|
# haml-contrib is not installed.
|
||||||
begin
|
begin
|
||||||
require "haml/filters/maruku"
|
require "haml/filters/maruku"
|
||||||
|
|
|
@ -97,7 +97,7 @@ module Haml
|
||||||
|
|
||||||
# If set to `true`, Haml will convert underscores to hyphens in all
|
# If set to `true`, Haml will convert underscores to hyphens in all
|
||||||
# {file:REFERENCE.md#html5_custom_data_attributes Custom Data Attributes} As
|
# {file:REFERENCE.md#html5_custom_data_attributes Custom Data Attributes} As
|
||||||
# of Haml 3.2, this defaults to `true`.
|
# of Haml 4.0, this defaults to `true`.
|
||||||
attr_accessor :hyphenate_data_attrs
|
attr_accessor :hyphenate_data_attrs
|
||||||
|
|
||||||
# The line offset of the Haml template being parsed. This is useful for
|
# The line offset of the Haml template being parsed. This is useful for
|
||||||
|
|
Loading…
Reference in a new issue