kaelig / sass-library-boilerplate

A boilerplate for building Sass libraries and frameworks

Sass Library Boilerplate

The Sass Library Boilerplate is a set of files that are a good base to publish well documented and tested Sass libraries, micro-frameworks, mixins and functions.

Quick Start

1. Download, clone or fork this repository
2. Replace all occurrences of "sass-library", "Sass Library", "user/"… to your own library and user names.
3. Also, remove this first part of the README

Features

• Pre-filled README, package.json, sache.json
• SassDoc configuration, with tasks that publish a beautiful documentation to GitHub Pages
• Unit tests with examples
• Continuous integration with Travis
• A changelog
• .editorconfig for consistent whitespace/tabs across files
• Eyeglass-enabled

---

Sass Library

library() is a Sass mixin that helps doing something.

Short description.

Why the tool was built (optional).

Getting started

Very simple piece of code showing the most basic usage of library().

$library-default-message: 'foo';
@import 'path/to/library/index.scss';

.foo {
  @include library();
}

Running tests

Clone the repository, then:

npm install
npm test

Generating the documentation

Sass Library's API is documented using SassDoc.

npm run sassdoc

Generate & deploy the documentation to https://user.github.io/sass-library/:

# First time deploying the documentation?
npm run sassdoc-deploy-first-time

# Any other time:
npm run sassdoc-deploy

License

Source code is licensed under BSD License Clause 2.

Acknowledgments

Thank you to people who have helped.