CastleCSS icons
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
sass
.gitignore
.npmignore
README.md
package.json

README.md

CastleCSS Icons Files

CastleCSS icon set via Font Awesome and Cloudflare.

CastleCSS logo @CastleCss.com

CastleCSS Framework

The icon package is part of the CastleCSS Meta Package, you need this, the castlecss-core or create your own variables files in order to make castlecss-icons work.

Since castlecss-icons v1.0 the castlecss-core is automatically installed into your node_modules too.

Even easier: Download the CastleCSS Boilerplate. All Packages are included + examples and project setup

How to install

  • Download the CastleCSS Boilerplate. All Packages are included + examples and project setup
  • Install via NPM: npm install castlecss-icons
  • Require it in your own NPMJS package
  • Download or clone the package

Updating files

CastleCSS is built so it's easy to update, you can just download make it your own as long as you don't ovewrite the core files.

npm update castlecss-icons

Documentation and examples

You can find the documentation and examples at http://www.castlecss.com and castlecss-docs

Setup

Your project should have a setup similair to this (included in the CastleCSS Boilerplate): With this you make sure your own variables overwrite the castle-core variables and your setup is still updatable.

| Your project/
|
|-- scss/ 
| |-- /* Custom project specific scss files here */
| |-- Main.scss
| |
|-- node_modules/
| | 
| | /*	CastleCSS files included automatically here */
| | castlecss-core/
| | castlecss-icons/
| | castlecss-etc ;)/

Main.scss

Your main.scss should have a setup similair to this (included in the Full CastleCSS Boilerplate):

/*  core variable files */
@import "path/to/castlecss-core/sass/variables";

/*  Your own variables so they overwrite the core */
@import "variables";

/*  rest of core files */
@import "node_modules/castlecss-core/sass/main";
@import "node_modules/castlecss-icons/sass/main";

 
/*  Include your own files below this line
    --------------------------------------
*/

Roadmap

We're currently working hard on making the CastleCSS expansions and improvements. CastleCSS is made to serve as lightweight basis for tailor made software but we do want to give you the option to install a few modules to make your life easier.

Please see the ROADMAP.MD from the CastleCSS Meta Package for our current plans for the future.

Contributing

Want to contribute? We'd love your help, please take a look at the roadmap or submit new suggestions.