You can find the Neat Sass library source code here.
Get the code:
git clone https://github.com/thoughtbot/neat.bourbon.io.git
Set up your machine:
Run the app:
bundle exec middleman
Neat uses SassDoc to document its source code. For this website, we use
Rake tasks to run SassDoc’s CLI, which parses documentation-specific comments
from Neat’s source and outputs them as versioned JSON files
neat_2_0_0.json). We then use a proxy in Middleman to generate
unique pages for each version.
To generate documentation for the gem version specified in the
You can also generate documentation for the gem version from GitHub by using the
rake generate_for 2.0.0
Hosting & Deployment
The website is hosted on Netlify, and is automatically built and deployed when
changes are pushed to the
master branch. Credentials for Netlify can be found
This project uses:
- Sass, with Bourbon
- BEM-style CSS class names
library/: Global variables, mixins and functions; all non-rendering Sass
base/: Unclassed HTML elements (e.g.
patterns/: Abstractions, highly reusable pieces of style that are used in any number of unrelated contexts (e.g.
components/: Discrete, implementation-specific piece of UI (e.g.
views/: An object who's styles are modified by the view's body class (e.g.
- SCSS-Lint, with Hound (configuration)
- A variety of CSS units:
emfor typographical-related elements
remfor lengths related to components
pxfor borders, text shadows, etc.
vhfor lengths that should be relational to the viewport
emvalues) for font sizes