Skip to content

Latest commit

 

History

History
77 lines (54 loc) · 2.02 KB

README.md

File metadata and controls

77 lines (54 loc) · 2.02 KB
Raw

CalloutCSS

A CDN, Bower and NPM component holding CSS definitions for callouts. No Javascript or dependencies, ideal for use in any project which wants to add callout functionality.

Usage:

CalloutCSS contains the definitions for three types of callouts; NOTE, WARNING and DANGER. Simply add the following snippets to produce callouts in your websites.

<note-callout>
    An example of a NOTE callout
</note-callout>

note callout

<warning-callout>
    An example of a WARNING callout
</warning-callout>

warning callout

<danger-callout>
    An example of a DANGER callout
</danger-callout>

danger callout

Further customisations of the callouts can be found on the fully fleshed out examples documentation.

Installation:

CDN

<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/calloutcss@1.0.0/dist/callout.min.css" integrity="sha256-SYSQemsIxvfjHJ04VeAy0VS4pH7i/0qZUwwz0vq5wXk= sha384-/RloR6ZLXi3i248Eyg42OhYXAkSHlAXR/5AhAV0zl8vq1kbnWFoiAuO+6065k9xA" crossorigin="anonymous">

Bower

$ bower install calloutcss

NPM

$ npm install calloutcss

Development:

To pull and develop this package NPM and webpack is used to manage the development dependencies and transpile the SCSS file into the final CSS distribution.

Setup Environment:

$ npm install

Build/Compile the SCSS:

$ npm run build

NOTE: hack.js is used as part of the build step generating ignore.js, however this is an artefact of the build stage and is not packaged in releases. Unfortunately Webpack MUST have a javascript entry point from which any (S)CSS is gathered and then output for distribution.

Copyright and license

Code copyright 2018 TheYorkshireDev (Steven Cooney). Code released under the MIT license.