Skip to content
Browse files

Merge pull request #218 from thoughtbot/rl-docset-naming

Rename section titles in the docs and docset
  • Loading branch information...
2 parents 0b9abf9 + fa8aca8 commit d984e1c90cbfb8626b9a33af1351702e21c3221d Phil LaPier committed Apr 9, 2013
View
2 _includes/animation.html
@@ -1,5 +1,5 @@
<article id="animations" data-type="mixin">
- <h2>Animations <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/css3/_animation.scss">View source</a></h2>
+ <h2>Animation <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/css3/_animation.scss">View source</a></h2>
<p>The animation mixins support comma separated lists of values, which allows different transitions for individual properties to be described in a single style rule. Each value in the list corresponds to the value at that same position in the other properties.</p>
{% highlight scss %}
View
2 _includes/background-image.html
@@ -1,5 +1,5 @@
<article id="background-image" data-type="mixin">
- <h2>Background Image <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/css3/_background-image.scss">View source</a></h2>
+ <h2>Background-image <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/css3/_background-image.scss">View source</a></h2>
<p>The background-image mixin is helpful for chaining multiple comma delimited background images and/or linear/radial-gradients into one background-image property. The Background-image mixin supports up to 10 background-images.</p>
<p>Use in combination with the <a href="#linear-gradient-function">linear-gradient function</a> and the <a href="#radial-gradient-function">radial-gradient function</a>.
View
2 _includes/background-size.html
@@ -1,5 +1,5 @@
<article id="background-size" data-type="mixin">
- <h2>Background Size<a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/css3/_background-size.scss">View source</a></h2>
+ <h2>Background-size <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/css3/_background-size.scss">View source</a></h2>
<p>The background-size mixin supports multiple background-sizes for use with multiple background-images via comma delimitation.</p>
{% highlight scss %}
View
2 _includes/border-image.html
@@ -1,5 +1,5 @@
<article id="border-image" data-type="mixin">
- <h2>Border Image<a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/css3/_border-image.scss">View source</a></h2>
+ <h2>Border-image <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/css3/_border-image.scss">View source</a></h2>
<p>Border-image supports short-hand notation.</p>
{% highlight scss %}
View
2 _includes/border-radius.html
@@ -1,5 +1,5 @@
<article id="border-radius" data-type="mixin">
- <h2>Border Radius Helpers <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/css3/_border-radius.scss">View source</a></h2>
+ <h2>Border-radius <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/css3/_border-radius.scss">View source</a></h2>
<p>The border-radius helper mixins provide shortcuts for targeting sides. These mixins are supported in Bourbon v3.0+</p>
View
2 _includes/box-shadow.html
@@ -1,5 +1,5 @@
<article id="box-shadow" data-type="mixin">
- <h2>Box Shadow<a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/css3/_box-shadow.scss">View source</a></h2>
+ <h2>Box-shadow <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/css3/_box-shadow.scss">View source</a></h2>
<p>Box-shadow supports single or multiple arguments.</p>
<h3>Single Box Shadow</h3>
View
2 _includes/box-sizing.html
@@ -1,5 +1,5 @@
<article id="box-sizing" data-type="mixin">
- <h2>Box Sizing<a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/css3/_box-sizing.scss">View source</a></h2>
+ <h2>Box-sizing <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/css3/_box-sizing.scss">View source</a></h2>
<p>Box-sizing will change the box-model of the element it is applied to.</p>
{% highlight scss %}
View
2 _includes/buttons.html
@@ -1,5 +1,5 @@
<article id="buttons" data-type="mixin">
- <h2>Buttons <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/addons/_button.scss">View source</a></h2>
+ <h2>Button <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/addons/_button.scss">View source</a></h2>
<p>The button add-on provides well-designed buttons with a single line in your CSS.</p>
<p>The mixin supports a style parameter and an optional color argument. The available button styles are:</p>
<ul>
View
2 _includes/flex-box.html
@@ -1,5 +1,5 @@
<article id="flex-box" data-type="mixin">
- <h2>Flex Box <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/css3/_flex-box.scss">View source</a></h2>
+ <h2>Box <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/css3/_flex-box.scss">View source</a></h2>
<p>The flex-box mixin is based on the 2009 w3c spec. <a href="http://www.w3.org/TR/2009/WD-css3-flexbox-20090723/">More info</a></p>
<p>Looking for mixins for the latest 2012 spec? <a href="https://github.com/thoughtbot/bourbon/issues/115">Click here</a>
{% highlight scss %}
View
2 _includes/flex-grid.html
@@ -1,5 +1,5 @@
<article id="flex-grid" data-type="function">
- <h2>Flex Grid <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/functions/_flex-grid.scss">View source</a></h2>
+ <h2>Flex-grid <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/functions/_flex-grid.scss">View source</a></h2>
<p>Use this mixin to easily create a flexible-grid layout.</p>
<p>The <code>$fg-column</code>, <code>$fg-gutter</code> and <code>$fg-max-columns</code> variables must be defined in your base stylesheet to properly use the flex-grid function.</p>
<p>This function takes the fluid grid equation (target / context = result) and uses columns to help define each.</p>
View
2 _includes/font-face.html
@@ -1,5 +1,5 @@
<article id="font-face" data-type="mixin">
- <h2>Font-Face <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/css3/_font-face.scss">View source</a></h2>
+ <h2>Font-face <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/css3/_font-face.scss">View source</a></h2>
<p>A simple <code>@font-face</code> mixin allowing easier custom fonts integration, like so:</p>
<p>The mixin also takes an optional <code>$asset-pipeline: true</code> argument for use with the Rails asset pipeline.</p>
View
2 _includes/font-family.html
@@ -1,5 +1,5 @@
<article id="font-family" data-type="variable">
- <h2>Font-Family <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/addons/_font-family.scss">View source</a></h2>
+ <h2>Font-family <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/addons/_font-family.scss">View source</a></h2>
<p>Bourbon defines default font-families as variables for the sake of convenience:</p>
{% highlight scss %}
View
2 _includes/golden-ratio.html
@@ -1,5 +1,5 @@
<article id="golden-ratio" data-type="function">
- <h2>Golden Ratio <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/functions/_modular-scale.scss">View Source</a></h2>
+ <h2>Golden-ratio <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/functions/_modular-scale.scss">View Source</a></h2>
<p>Returns the golden ratio of a given number. Must provide a pixel or em value for the first argument. Also takes a required integer for an increment value: ...-3, -2, -1, 0, 1, 2, 3...</p>
<p>Note: The golden-ratio function can be wrapped in sass's <code>abs()</code>, <code>floor()</code>, or <code>ceil()</code> functions to get the absolute value, round down, or round up respectively.</p>
View
2 _includes/grid-width.html
@@ -1,5 +1,5 @@
<article id="grid-width" data-type="function">
- <h2>Grid Width <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/functions/_grid-width.scss">View source</a></h2>
+ <h2>Grid-width <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/functions/_grid-width.scss">View source</a></h2>
<p>Easily setup and follow a grid based design. Check out <a href="http://gridulator.com/">gridulator.com</a></p>
<p>The <code>$gw-column</code> and <code>$gw-gutter</code> variables must be defined in your base stylesheet to properly use the grid-width function.</p>
View
2 _includes/hide-text.html
@@ -1,5 +1,5 @@
<article id="hide-text" data-type="mixin">
- <h2>Hide Text<a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/addons/_hide-text.scss">View Source</a></h2>
+ <h2>Hide-text <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/addons/_hide-text.scss">View Source</a></h2>
<p>Hide-text is an image replacement mixin. It is based off the <a href="https://github.com/h5bp/html5-boilerplate/commit/aa0396eae757c9e03dda4e463fb0d4db5a5f82d7">HTML5-Boilerplate image-replacement</a>.</p>
<p>This image replacement technique is an alternative to the text-indent technique, which has <a href="http://nicolasgallagher.com/another-css-image-replacement-technique/">performance and other benefits</a>.</p>
View
2 _includes/hidpi-media-query.html
@@ -1,5 +1,5 @@
<article id="hidpi-media-query" data-type="mixin">
- <h2>HIDPI Media Query <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/css3/_hidpi-media-query.scss">View source</a></h2>
+ <h2>HIDPI-media-query <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/css3/_hidpi-media-query.scss">View source</a></h2>
<p>The HIDPI Meda Query will allow you to generate a media query that targes HIDPI devices. It accepts an optional ratio argument, default ratio is 1.3. <a href="http://bjango.com/articles/min-device-pixel-ratio/">Find my device pixel ratio.</a></p>
{% highlight scss %}
View
2 _includes/image-rendering.html
@@ -1,5 +1,5 @@
<article id="image-rendering" data-type="mixin">
- <h2>Image-rendering<a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/css3/_image-rendering.scss">View source</a></h2>
+ <h2>Image-rendering <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/css3/_image-rendering.scss">View source</a></h2>
<p>The <code>image-rendering</code> property provides a hint to the user agent about how to handle its image rendering.</p>
{% highlight scss %}
View
2 _includes/inline-block.html
@@ -1,5 +1,5 @@
<article id="inline-block" data-type="mixin">
- <h2>Inline Block <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/css3/_inline-block.scss">View source</a></h2>
+ <h2>Inline-block <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/css3/_inline-block.scss">View source</a></h2>
<p>The inline-block mixin provides support for the inline-block property in IE6 and IE7.</p>
{% highlight scss %}
View
2 _includes/keyframes.html
@@ -1,5 +1,5 @@
<article id="keyframes" data-type="mixin">
- <h2>Keyframes<a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/css3/_keyframes.scss">View source</a></h2>
+ <h2>Keyframes <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/css3/_keyframes.scss">View source</a></h2>
<p>A mixin for generating clean vendor-prefixed keyframes.</p>
{% highlight scss %}
View
2 _includes/linear-gradient-function.html
@@ -1,5 +1,5 @@
<article id="linear-gradient-function" data-type="function">
- <h2>Linear Gradient <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/functions/_linear-gradient.scss">View source</a></h2>
+ <h2>Linear-gradient <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/functions/_linear-gradient.scss">View source</a></h2>
<p>Outputs a linear-gradient. Use in conjunction with the <a href="#background-image">background-image mixin.</a> The function takes the same arguments as the <a href="#linear-gradient">linear-gradient mixin</a>.</p>
{% highlight scss %}
View
2 _includes/linear-gradient.html
@@ -1,5 +1,5 @@
<article id="linear-gradient" data-type="mixin">
- <h2>Linear Gradient <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/css3/_linear-gradient.scss">View source</a></h2>
+ <h2>Linear-gradient <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/css3/_linear-gradient.scss">View source</a></h2>
<p>Gradient Position is optional, default is <code>top</code>. Position can be a degree (<code>90deg</code>). Mixin supports up to 10 color-stops.</p>
<p>This mixin will output a fallback <code>background-color: #first-color;</code> declaration. A <code>$fallback</code> argument can be passed to change the fallback color.</p>
View
2 _includes/modular-scale.html
@@ -1,5 +1,5 @@
<article id="modular-scale" data-type="function">
- <h2>Modular Scale <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/functions/_modular-scale.scss">View Source</a></h2>
+ <h2>Modular-scale <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/functions/_modular-scale.scss">View Source</a></h2>
<p>Returns the modular scale of a given number. Must provide a number value for the first argument. The second argument is a required integer for an increment value: ...-3, -2, -1, 0, 1, 2, 3... The third value is the ratio number.</p>
<p>Note: The function can be wrapped in sass's <code>abs()</code>, <code>floor()</code>, or <code>ceil()</code> functions to get the absolute value, round down, or round up respectively.</p>
View
2 _includes/px-to-em.html
@@ -1,5 +1,5 @@
<article id="px-to-em" data-type="function">
- <h2>Pixels to Ems<a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/functions/_px-to-em.scss">View source</a></h2>
+ <h2>Em <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/functions/_px-to-em.scss">View source</a></h2>
<p>Convert pixels to ems.</p>
<p>For a relational value, the input is calculated based on a parent value. The default parent is 16px.<br>The parent can be changed by passing an optional second value.</p>
{% highlight scss %}
View
2 _includes/radial-gradient-function.html
@@ -1,5 +1,5 @@
<article id="radial-gradient-function" data-type="function">
- <h2>Radial Gradient <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/functions/_radial-gradient.scss">View source</a></h2>
+ <h2>Radial-gradient <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/functions/_radial-gradient.scss">View source</a></h2>
<p>Outputs a radial-gradient. Use in conjunction with the <a href="#background-image">background-image mixin.</a> The function takes the same arguments as the <a href="#radial-gradient">radial-gradient mixin</a>.</p>
{% highlight scss %}
View
2 _includes/retina-image.html
@@ -1,5 +1,5 @@
<article id="retina-image" data-type="mixin">
- <h2>Retina-Image<a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/addons/_retina-image.scss">View source</a></h2>
+ <h2>Retina-image <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/addons/_retina-image.scss">View source</a></h2>
<p>The mixin is a helper to generate a retina background-image and non-retina background-image. The retina background-image will output to a hidpi media-query.</p>
<p>The mixin uses a <code>@2x.png</code> retina filename by default.<br>
For rails, you can use the asset-pipeline by passing <code>true</code> to the argument.</p>
View
2 _includes/transform-origin.html
@@ -1,5 +1,5 @@
<article id="transform-origin">
- <h2>Transform Origin</h2>
+ <h2>Transform-origin</h2>
{% highlight scss %}
@include transform-origin(center top);
View
2 _includes/transform.html
@@ -1,5 +1,5 @@
<article id="transform" data-type="mixin">
- <h2>Transform / Origin / Style<a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/css3/_transform.scss">View source</a></h2>
+ <h2>Transform <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/css3/_transform.scss">View source</a></h2>
<p>The CSS <code>transform</code> property lets you modify the coordinate space of the CSS visual formatting model. Using it, elements can be translated, rotated, scaled, and skewed according to the values set</p>
<p>The <code>transform-origin</code> CSS property lets you modify the origin for transformations of an element.</p>
<p>The <code>transform-style</code> CSS property determines if the children of the element are positioned in the 3D-space or are flattened in the plane of the element.</p>
View
2 _includes/transitions.html
@@ -1,5 +1,5 @@
<article id="transitions" data-type="mixin">
- <h2>Transitions <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/css3/_transition.scss">View source</a></h2>
+ <h2>Transition <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/css3/_transition.scss">View source</a></h2>
<p>The shorthand mixin supports multiple transition.</p>
<p>Transition a vendor-prefixed property: <a href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/functions/_transition-property-name.scss">View source</a></p>
View
2 _includes/triangle.html
@@ -1,5 +1,5 @@
<article id="triangle" data-type="mixin">
- <h2>Triangle<a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/addons/_triangle.scss">View source</a></h2>
+ <h2>Triangle <a class="view-source" href="https://github.com/thoughtbot/bourbon/blob/master/app/assets/stylesheets/addons/_triangle.scss">View source</a></h2>
<p>Creates a visual triangle. Mixin takes <code>($size, $color, $direction)</code></p>
{% highlight scss %}
View
2 docset/Bourbon.xml
@@ -1,4 +1,4 @@
<entry>
- <version>3.1.1</version>
+ <version>3.1.1/2</version>
<url>http://bourbon.io/docset/bourbon.tgz</url>
</entry>
View
BIN docset/bourbon.tgz
Binary file not shown.

0 comments on commit d984e1c

Please sign in to comment.
Something went wrong with that request. Please try again.