Document the reset module.

This commit is contained in:
Chris Eppstein 2010-04-30 07:04:13 -07:00
parent c1be6c9362
commit 3992cecbea
3 changed files with 27 additions and 3 deletions

View File

@ -11,4 +11,11 @@ classnames:
meta_description: Adds a CSS Reset into your stylesheet. meta_description: Adds a CSS Reset into your stylesheet.
--- ---
- render 'reference' do - render 'reference' do
This module applies the <a href="/docs/reference/compass/utilities/general/reset/#mixin-global-reset">global reset</a> to your stylesheet by simply importing it. :markdown
This module applies the [global reset](/docs/reference/compass/reset/utilities/#mixin-global-reset)
to your stylesheet by simply importing it.
**Note:** This module will place styles into your stylesheet by importing it. This
is not the standard behavior of a compass module but it optimizes the common use case.
If you want to control the reset, please use the mixins defined in the [reset
utilities module](/docs/reference/compass/reset/utilities/)

View File

@ -0,0 +1,17 @@
---
title: Compass Reset Utilities
crumb: Reset Utilities
framework: compass
stylesheet: compass/reset/_utilities.scss
layout: core
meta_description: Mixins for resetting elements.
classnames:
- reference
- core
- utilities
---
- render 'reference' do
:markdown
These utilities are used to reset your document. The easiest way to use them
is to simply `@import "compass/reset"` which will import this module and apply
the appropriate mixins for you.

View File

@ -4,7 +4,7 @@ crumb: Reset
framework: compass framework: compass
stylesheet: compass/utilities/general/_reset.scss stylesheet: compass/utilities/general/_reset.scss
layout: core layout: core
meta_description: Mixins for resetting elements. meta_description: Mixins for resetting elements (old import).
nav_stylesheet: compass/_utilities.scss nav_stylesheet: compass/_utilities.scss
classnames: classnames:
- reference - reference
@ -13,4 +13,4 @@ classnames:
--- ---
- render 'reference' do - render 'reference' do
%p %p
Lorem ipsum dolor sit amet. This is a legacy wrapper for the <code>reset/utilities</code> module.