A mixin to generate modular scale and vertical rhythm for your typography
Clone or download
Gavin McFarland
Latest commit 905dbd4 Apr 5, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples Reorganised files Mar 30, 2017
LICENSE.txt Added MIT license. Closes #3 Aug 3, 2013
README.md Variable for font-scale corrected Apr 5, 2017
bower.json Typos on readme file Mar 30, 2017
rhythm.less Reorganised files Mar 30, 2017
rhythm.sass Reorganised files Mar 30, 2017
rhythm.styl Reorganised files Mar 30, 2017

README.md

Gridlover Mixin

I built this mixin to help generate CSS files inspired by Gridlover's tool which lets you create typography with modular scale and vertical rhythm. These mixins only supplement the hard work Tuomas Jomppanen & Ville Vanninen have already done at www.gridlover.net, be sure to check it out.

Setup

Install the appropriate Stylus, SASS, or LESS preprocessor.

Add the correct rhythm mixin file to your project.

Then add the following file to the top of your main stylesheet. The example below uses Stylus, so be sure to change the syntax to match your chosen CSS preprocessor.

// Configure variables here
$unit = "px"
$base-font-size = 16px
$line-height-scale = 1.5
$font-scale = 1.5

@import 'rhythm'

If you are using ems or rems, then you will want to set the base rhythm of your document using the following.

html {
	rhythm: "base"
}

Usage

Use the rhythm mixin to set the vertical rhythm of each typographical element.

Arguments should be passed through as the font-size multiplier, margin-top multiplier, margin-bottom multiplier.

rhythm: font-size [, margin-top, margin-bottom, line-height]

For example

h1 {
	rhythm: 2, 1, 1
}

Outputs

h1 {
  font-size: 36px;
  line-height: 48px;
  margin-top: 24px;
  margin-bottom: 24px;
}

Custom line-height

By default the mixin calculates the appropriate line-height based on the computed font-size however if you wish to set this explicitly you can define it as the last argument in the mixin (unfortunately this feature only works in SASS and Stylus currently).

For example

p {
	rhythm: 0, 1, 1, 2 // each line of text will span two line heights
}

Configure

Change the default configuration for your project using the following variables.

  • $unit Set which unit you would like the measurements to be outputted to. Choose from "px", "em", "rem", or "pxrem". Use "pxrem" when you want rems with a pixel fallback.
  • $base-font-size Set to the font size of your body copy. All typographical elements are calculated from this base font size.
  • $line-height-scale Set the scale for the vertical rhythm of your typography.
  • $font-scale Set the scale for the relationship of font sizes between each typographical element.
  • $true-scale Set to true if you would prefer the font size to be a direct multiple of the font-size multiplier (unfortunately this feature only works in SASS and Stylus currently).

Example

$unit = "rem"
$base-font-size = 14px
$line-height-scale = 1.5
$font-scale = 1.618
$true-scale = true

Changelog

v2.0.0 (Mar 30 2016)

  • Upgraded SASS and LESS mixin

v1.4.0 (Mar 26 2016)

  • Refactored Stylus mixin
  • Added support for, em, rem, pxrem
  • Removed ouput of empty empty values
  • Included the $ character for valuble for easier identification
  • Added line-height multiplier parameter to rhythm()
  • Added $true-scale option to config file

v1.3.0 (Jul 20, 2015)

  • Added Bower support

v1.2.0 (Aug 3, 2013)

  • Added MIT License

v1.1.0 (Jul 29, 2013)

  • Added LESS support

v1.0.0 (Oct 26, 2012)

  • Stable version

v0.1.0 (Oct 23, 2012)

  • Initial commit

Special thanks

Thanks to:

License

This is licenced under the MIT License