<commit_before># Acme Styleguide

This is an example project that uses [hologram](http://trulia.github.io/hologram) to build [this style
guide](http://acme-styleguide.cfapps.io). The instructions listed below assume that you have already installed Node / NPM, and have the Apple Developer Tools installed on your machine.

## Orientation

Hologram is a Ruby gem that parses specially formatted comments in your Sass/CSS and turns them into a living styleguide.

The two main directories that you will be interacting with are `styleguide-theme` and `styles`. 

The former directory is home to the Header and Footer of your styleguide, as well as any static assets you might need to theme it (Yes, you can _style_ the _styleguide_ via this directory). Note that the Header and Footer are simple HTML files, wherein you can pull in 3rd party assets (in this case, [Bootstrap](http://getbootstrap.com), [Font Awesome](http://fontawesome.io), and the [Roboto Web Font](https://fonts.google.com/specimen/Roboto). Hologram is smart enough to spit out the content of your styleguide _in between_ said header and footer, so don't worry about having to know any Ruby!

Where the fun begins is the `styles` folder, which is home to a list of Sass files. Feel free to write vanilla CSS, or SCSS-flavored Sass -- the only requirement is that any new files you add to the directory are imported in the `style.scss` file. For example, if you were to add a new file to the directory called `_toasts.scss`, be sure to add a corresponding statement in `style.scss`.


    @import 'toasts';

In order for that element to be added to the styleguide, add a [Hologram Comment](https://github.com/trulia/hologram#quick-start) to the top of the file.


    /*doc
    ---
    title: Toasts
    name: toast
    category: components<commit_msg>Update README with badge and add missing parenthesis<commit_after>[![forthebadge](http://forthebadge.com/images/badges/pretty-risque.svg)](http://forthebadge.com)

# Acme Styleguide

This is an example project that uses [hologram](http://trulia.github.io/hologram) to build [this style
guide](http://acme-styleguide.cfapps.io). The instructions listed below assume that you have already installed Node / NPM, and have the Apple Developer Tools installed on your machine.

## Orientation

Hologram is a Ruby gem that parses specially formatted comments in your Sass/CSS and turns them into a living styleguide.

The two main directories that you will be interacting with are `styleguide-theme` and `styles`. 

The former directory is home to the Header and Footer of your styleguide, as well as any static assets you might need to theme it (Yes, you can _style_ the _styleguide_ via this directory). Note that the Header and Footer are simple HTML files, wherein you can pull in 3rd party assets (in this case, [Bootstrap](http://getbootstrap.com), [Font Awesome](http://fontawesome.io), and the [Roboto Web Font](https://fonts.google.com/specimen/Roboto)). Hologram is smart enough to spit out the content of your styleguide _in between_ said header and footer, so don't worry about having to know any Ruby!

Where the fun begins is the `styles` folder, which is home to a list of Sass files. Feel free to write vanilla CSS, or SCSS-flavored Sass -- the only requirement is that any new files you add to the directory are imported in the `style.scss` file. For example, if you were to add a new file to the directory called `_toasts.scss`, be sure to add a corresponding statement in `style.scss`.


    @import 'toasts';

In order for that element to be added to the styleguide, add a [Hologram Comment](https://github.com/trulia/hologram#quick-start) to the top of the file.


    /*doc
    ---
    title: Toasts
    name: toast
    category: components
{'fraction_non_alphanumeric': 0.07290562036055143, 'fraction_numerical': 0.0005302226935312832, 'mean_word_length': 4.204137931034483, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3123667', 'n_tokens_mistral': 1068, 'n_tokens_neox': 1041, 'n_words': 530}