<commit_before>```
 _______ __         __        _____
|     __|  |_.--.--|  |-----.|     \-----.----.----.-----.
|__     |   _|  |  |  |  -__||  --  | _  |  __|  __|  _  |
|_______|____|___  |__|_____||_____/_____|____|____|_____|
             |_____|
```

About
-----

StyleDocco takes your stylesheets and generates style guide documents with the processed stylesheets applied to the documents.

`styledocco main.css` will generate `docs/main.html` with all the comments from the file (passed through GitHub flavored Markdown) in one column, and all the code in another column.

The CSS in `main.css` will be applied to the page. This means you can add sample HTML content in the comments of your CSS file, and have it rendered in the browser using that same CSS.

To add extra default styles to your documentation, add a file named `docs.css` in your `docs` folder.

If you point StyleDocco to a directory, it will add a menu to navigate between the different files. If your project includes a `README` file, it will be used as the base for an `index.html`.

StyleDocco will automatically compile any SASS, SCSS, Less or Stylus code before it is applied to the page. Hidden files and SASS partials will be ignored.


Install
-------

*Warning*: StyleDocco is still rough around the edges. Please contribute by reporting bugs or submitting pull requests.

`npm install styledocco`


Examples
--------

Live examples coming soon.

```
/* <button class="btn btn-primary">Primary</button>   
   Provides extra visual weight and identifies the primary action in a set of buttons */
.btn.btn-primary {
  background: blue;
  color: white;
}
```

Would output an HTML document with one column displaying the rendered button followed by the description, and another column with the code. The code will also be included in a `style` element of the document.


Acknowledgements
----------------

Thanks to:

 * [jashkenas](https://github.com/jashkenas/docco)
 * [mbrevoort](https://github.com/mbrevoort/docco-husky)<commit_msg>Update readme with up to date examples.<commit_after>```
 _______ __         __        _____
|     __|  |_.--.--|  |-----.|     \-----.----.----.-----.
|__     |   _|  |  |  |  -__||  --  | _  |  __|  __|  _  |
|_______|____|___  |__|_____||_____/_____|____|____|_____|
             |_____|
```

About
-----

StyleDocco takes your stylesheets and generates style guide documents with the processed stylesheets applied to the documents.

`styledocco --name 'My Site' main.css` will generate `docs/main.html` with all the comments from the file (passed through GitHub flavored Markdown) in one column, and all the code in another column.

The CSS in `main.css` will be applied to the page. This means you can add sample HTML content in the comments of your CSS file, and have it rendered in the browser using that same CSS.

To add extra default styles to your documentation, add a file named `docs.css` in your `docs` folder.

If you point StyleDocco to a directory, it will add a menu to navigate between the different files. If your project includes a `README` file, it will be used as the base for an `index.html`.

StyleDocco will automatically compile any SASS, SCSS, Less or Stylus code before it is applied to the page. Hidden files and SASS partials will be ignored.


Install
-------

StyleDocco requires [Node.js](http://nodejs.org).

`npm install -g styledocco`


Usage
-----

`styledocco [options] [INPUT]`

**Options**
 * `--name, -n` - Name of the project [required]
 * `--out, -o`  - Output directory [optional, default: "docs"]
 * `--tmpl`     - Directory for custom `readme.jade` and `docs.jade` templates. [optional]


Examples
--------

```
/* <button class="btn btn-primary">Primary</button>   
   Provides extra visual weight and identifies the primary action in a set of buttons */
.btn.btn-primary {
  background: blue;
  color: white;
}
```

Would output an HTML document with one column displaying the rendered button followed by the description, and another column with the code. The code will also be included in a `style` element of the document.

See the `examples` folder for more in-depth examples.


Acknowledgements
----------------

Thanks to:

 * [jashkenas](https://github.com/jashkenas/docco)
 * [mbrevoort](https://github.com/mbrevoort/docco-husky)
{'fraction_non_alphanumeric': 0.11753774680603948, 'fraction_numerical': 0.0, 'mean_word_length': 3.0892687559354224, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 4, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6129900', 'n_tokens_mistral': 1284, 'n_tokens_neox': 1229, 'n_words': 523}