npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

cps-scss-framework

v0.4.2

Published

SCSS Framework to provide frequently used functions, mixins and styles.

Downloads

8

Readme

SCSS Framework

Frontend SCSS Framework to provide frequently used functions, mixins and styles.

Install

To use this framework you can simply download the project here on github, or install it with npm.

$ npm install cps-scss-framework

Usage

There are two ways of usage for this framework. The first option is to include the compiled dist/framework.css in your project. The second, more preferable, option is to include the src/framework.scss in your project and overwrite the default settings.

A) Include the pre-compiled css file

You can use the pre-compiled css file as standalone framework in your project. The Framework comes with some default options and styles, which cannot be overwritten in this method.

1.) Include the framework.css in your <head> section.

After you installed the framework as described in the Install section simply include the compiled .css file in your page <head> section.

<link rel="stylesheet" href="path/to/framwork/dist/framework.css">

2.) Use the included classes to style your website.

To learn more about all the included classes check out the Classes documentation.

B) Include the scss file and use your own settings

To overwrite some of the predefined styles you can include the framework in your SCSS setup.

1.) Create your own configuration file.

After you installed the framework as described in the Install section you should create your personal configuration file. Simply copy the src/_config.scss file to your scss path and change the configuration according to your needs.

Attention: Make sure to import your configuration file before the framework.scss!

2.) Import the framework.scss in your project.

After you created your personal configuration you need to include the framework.scss file in your projects main .scss file.

@import 'path/to/framework/src/framework.scss';

Attention: Make sure to import your configuration file before the framework.scss!

3.) Use the included functions, mixins and classes in your project.

Now you can use all the included functions, mixins and classes with your own configuration in your project. See the Functions, Mixins and Classes Documentation for further details.

Configuration

For all Configuration options see the Configuration documentation.

Included Functions, Mixins and Classes

The framework comes with many functions, mixins and classes, below you will find a short overview grouped by each module.

Global

Basic Functions and Mixins used by other modules.

License

Code released under the MIT License.