skeletonic-stylus
Version:
A lightweight, intuitive, accessible and ultra-responsive Stylus Library to streamline your digital and mobile web development needs. Proudly made with Stylus ❤
321 lines (263 loc) • 14.5 kB
Markdown
# Welcome to the Skeletonic Stylus Library
[](https://app.codacy.com/gh/sebastienrousseau/skeletonic-stylus?utm_source=github.com&utm_medium=referral&utm_content=sebastienrousseau/skeletonic-stylus&utm_campaign=Badge_Grade_Settings)
[](https://www.npmjs.com/package/skeletonic-stylus)
[](https://github.com/sebastienrousseau/skeletonic-stylus/releases/)
[](https://opensource.org/licenses/MIT)
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fsebastienrousseau%2Fskeletonic-stylus?ref=badge_shield)
[](https://www.npmjs.com/package/skeletonic-stylus)
[](#the-skeletonic-stylus-library)
[](https://github.com/sebastienrousseau/skeletonic-stylus/archive/v1.1.2.zip)
## Index
- [Welcome to the Skeletonic Stylus Library](#welcome-to-the-skeletonic-stylus-library)
- [Index](#index)
- [The Skeletonic Stylus Library](#the-skeletonic-stylus-library)
- [Documentation](#documentation)
- [Installation](#installation)
- [From NPM or YARN](#from-npm-or-yarn)
- [From CDN](#from-cdn)
- [From GitHub](#from-github)
- [What's included](#whats-included)
- [Support for bidirectional languages](#support-for-bidirectional-languages)
- [Versioning](#versioning)
- [Built with](#built-with)
- [Contributing](#contributing)
- [Code of Conduct](#code-of-conduct)
- [Our Values](#our-values)
- [Releases](#releases)
- [License](#license)
- [Acknowledgements](#acknowledgements)
## The Skeletonic Stylus Library
[Skeletonic Stylus Library](https://github.com/sebastienrousseau/skeletonic-stylus) is a lightweight, intuitive, accessible and ultra-responsive Stylus Library.
The library provides modular components built for speed, higher performance, with the aim of helping you come to grips with common pain points in mobile and web application design and development.
The Skeletonic Stylus Library is a collection of components, functions, and mixins made with [Stylus](https://stylus-lang.com/). The components and mixins can be used on their own to build modern web sites and applications, but they are also designed to be used in combination with a wide variety of existing technologies.
### Documentation
To read the Skeletonic Stylus Documentation, please visit:
- English Documentation: <https://docs.skeletonic.io/en>
- Documentation Française: <https://docs.skeletonic.io/fr>
- Documentation source code: <https://github.com/sebastienrousseau/skeletonic-docs>
## Installation
### From NPM or YARN
To install the Skeletonic Stylus Library, use either npm or yarn as follows:
- `npm install skeletonic-stylus`
- `yarn add skeletonic-stylus`
### From CDN
A pre-bundled package that contains all compiled CSS, components and mixins needed to use is available on CDN.
The following table lists alternate CDN locations where Skeletonic Stylus is hosted.
| CDN | URL | HTTPS | Combo |
| ------------------------------------- | ----------------------------------------------------------------------------- | ----- | ----- |
| [GitHub Packages](https://docs.github.com/en/packages) | <https://github.com/sebastienrousseau/skeletonic-stylus/packages> | Yes | No |
| [unpkg](https://unpkg.com/) | <https://unpkg.com/skeletonic-stylus@1.1.2/css/skeletonic.min.css> | Yes | No |
| [jsDelivr](https://www.jsdelivr.com/) | <https://cdn.jsdelivr.net/npm/skeletonic-stylus@1.1.2/css/skeletonic.min.css> | Yes | Yes |
### From GitHub
Clone the main repository to get all source files including build scripts: `git clone https://github.com/sebastienrousseau/skeletonic-stylus.git`
## What's included
Within the download you'll find all the Stylus source files, compiled and minified CSS bundles as well as [CSS sourcemaps](https://developers.google.com/web/tools/chrome-devtools/javascript/source-maps) grouped into the _dist_ folder.
You'll see something like this:
```bash
skeletonic-1.1.2
dist
├── README.md
├── css
│ ├── animations
│ │ ├── skeletonic-animations-report.txt
│ │ ├── skeletonic-animations.css
│ │ ├── skeletonic-animations.css.map
│ │ └── skeletonic-animations.min.css
│ ├── core
│ │ ├── skeletonic-report.txt
│ │ ├── skeletonic.css
│ │ ├── skeletonic.css.map
│ │ └── skeletonic.min.css
│ ├── fonts
│ │ ├── skeletonic-fonts-report.txt
│ │ ├── skeletonic-fonts.css
│ │ ├── skeletonic-fonts.css.map
│ │ └── skeletonic-fonts.min.css
│ ├── hebrew-fonts
│ │ ├── skeletonic-hebrew-fonts-report.txt
│ │ ├── skeletonic-hebrew-fonts.css
│ │ ├── skeletonic-hebrew-fonts.css.map
│ │ └── skeletonic-hebrew-fonts.min.css
│ └── palettes
│ ├── material
│ │ ├── skeletonic-material-report.txt
│ │ ├── skeletonic-material.css
│ │ ├── skeletonic-material.css.map
│ │ └── skeletonic-material.min.css
│ ├── tachyons
│ │ ├── skeletonic-tachyons-report.txt
│ │ ├── skeletonic-tachyons.css
│ │ ├── skeletonic-tachyons.css.map
│ │ └── skeletonic-tachyons.min.css
│ └── websafe
│ ├── skeletonic-websafe-report.txt
│ ├── skeletonic-websafe.css
│ ├── skeletonic-websafe.css.map
│ └── skeletonic-websafe.min.css
├── filesize-report.txt
├── images
│ ├── button-primary.svg
│ ├── button-secondary.svg
│ ├── skeletonic-logo.svg
│ ├── skeletonic-stylus-readme.svg
│ └── skeletonic-stylus.svg
├── package.json
└── stylus
├── README.md
├── animations
│ ├── Distracting
│ │ ├── bounce.styl
│ │ ├── chameleonbackground.styl
│ │ ├── chameleontext.styl
│ │ ├── flash.styl
│ │ ├── heartbeat.styl
│ │ ├── jelly.styl
│ │ ├── pulse.styl
│ │ ├── rubber.styl
│ │ ├── shake.styl
│ │ ├── swing.styl
│ │ ├── tada.styl
│ │ └── wobble.styl
│ ├── Fading
│ │ ├── fadeIn.styl
│ │ ├── fadeInDown.styl
│ │ ├── fadeInLeft.styl
│ │ ├── fadeInRight.styl
│ │ ├── fadeInUp.styl
│ │ ├── fadeOut.styl
│ │ ├── fadeOutDown.styl
│ │ ├── fadeOutLeft.styl
│ │ ├── fadeOutRight.styl
│ │ └── fadeOutUp.styl
│ ├── Flipping
│ │ ├── flip.styl
│ │ ├── flipInHorizontal.styl
│ │ ├── flipInVertical.styl
│ │ ├── flipOutHorizontal.styl
│ │ └── flipOutVertical.styl
│ ├── Pop
│ │ ├── popIn.styl
│ │ └── popOut.styl
│ ├── README.md
│ ├── Rolling
│ │ ├── rollIn.styl
│ │ └── rollOut.styl
│ ├── Rotating
│ │ ├── spinLeft.styl
│ │ └── spinRight.styl
│ ├── Sliding
│ │ ├── slideInDown.styl
│ │ ├── slideInLeft.styl
│ │ ├── slideInRight.styl
│ │ ├── slideInUp.styl
│ │ ├── slideOutDown.styl
│ │ ├── slideOutLeft.styl
│ │ ├── slideOutRight.styl
│ │ └── slideOutUp.styl
│ ├── Vanishing
│ │ ├── vanishIn.styl
│ │ └── vanishOut.styl
│ ├── Zooming
│ │ ├── zoomIn.styl
│ │ └── zoomOut.styl
│ ├── _contents.styl
│ └── animationsBase.styl
├── base
│ ├── README.md
│ ├── _contents.styl
│ ├── helpers.styl
│ └── reset.styl
├── components
│ ├── README.md
│ ├── _contents.styl
│ ├── card.styl
│ ├── header.styl
│ └── navbar.styl
├── configurations
│ ├── README.md
│ ├── _contents.styl
│ ├── colors.styl
│ └── variables.styl
├── debugging
│ ├── base64
│ └── images
├── elements
│ ├── README.md
│ ├── _contents.styl
│ ├── button.styl
│ ├── clipboard.styl
│ ├── code.styl
│ ├── divider.styl
│ ├── fieldset.styl
│ ├── form.styl
│ ├── image.styl
│ ├── label.styl
│ ├── link-effects.styl
│ ├── link.styl
│ ├── list.styl
│ ├── margin.styl
│ ├── padding.styl
│ └── table.styl
├── fonts
│ ├── README.md
│ ├── _contents.styl
│ └── open-sans.styl
├── hebrew-fonts
│ ├── README.md
│ ├── _contents.styl
│ └── open-sans-hebrew.styl
├── layout
│ ├── README.md
│ ├── _contents.styl
│ ├── container.styl
│ ├── grid.styl
│ └── media-queries.styl
├── palettes
│ ├── README.md
│ ├── _contents.styl
│ ├── material.styl
│ ├── tachyons.styl
│ └── websafe.styl
├── skeletonic.styl
└── utilities
├── README.md
├── _contents.styl
└── mixins.styl
33 directories, 134 files
```
### Support for bidirectional languages
The Skeletonic Stylus Library can display Hebrew text and provides an extension font covering the Hebrew alphabet: [Open Sans Hebrew](https://open-sans.com/hebrew.html).
Simply link the CSS in your HTML document:
`<link rel="stylesheet" type="text/css" href="skeletonic-hebrew-fonts.min.css" />`
### Versioning
For transparency into our release cycle and in striving to maintain backward compatibility, the Skeletonic Stylus Library is maintained under the [Semantic Versioning](https://semver.org/) guidelines.
### Built with
- [CleanCSS](https://github.com/jakubpawlowicz/clean-css) - CleanCSS is a fast and efficient CSS optimizer for Node.js platform and any modern browser.
- [CSSO](https://github.com/css/csso) - CSSO (CSS Optimizer) is a CSS minifier with structural optimizations.
- [Node.js](https://nodejs.org/) - Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine.
- [NPM](https://www.npmjs.com/about) - npm is the package manager for Node.js.
- [Open Sans](https://open-sans.com/) - Open Sans is a humanist sans serif typeface designed by Steve Matteson.
- [PostCSS](https://github.com/postcss/postcss) - PostCSS is a tool for transforming styles with JS plugins.
- [Stylus Supremacy](https://thisismanta.github.io/stylus-supremacy/) - Stylus Supremacy is a JavaScript library for formatting Stylus files.
- [Stylus](http://stylus-lang.com/) - Expressive, robust, feature-rich CSS language built for nodejs
## Contributing
Please read carefully through our [Contributing Guidelines](https://github.com/sebastienrousseau/skeletonic-stylus/blob/main/.github/CONTRIBUTING.md) for further details on the process for submitting pull requests to us.
### Code of Conduct
We are committed to preserving and fostering a diverse, welcoming community. Please read our [Code of Conduct](https://github.com/sebastienrousseau/skeletonic-stylus/blob/main/.github/CODE_OF_CONDUCT.md).
### Our Values
- We believe perfection must consider everything.
- We take our passion beyond code into our daily practices.
- We are just obsessed about creating and delivering exceptional solutions.
### Releases
- See [Skeletonic Release](https://github.com/sebastienrousseau/skeletonic-stylus/releases) list.
### License
This project is licensed under the MIT License - see the [LICENSE](https://github.com/sebastienrousseau/skeletonic-stylus/blob/main/LICENSE) file for details
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fsebastienrousseau%2Fskeletonic-stylus?ref=badge_large)
### Acknowledgements
[The Skeletonic Stylus Library](https://skeletonicstylus.com) is beautifully crafted by these people and a bunch of awesome [contributors](https://github.com/sebastienrousseau/skeletonic-stylus/graphs/contributors)
| Contributors |
|---------|
|[](https://sebastienrousseau.co.uk)|
|[Sebastien Rousseau](https://github.com/sebastienrousseau)|
Made with ❤ in London. Powered by [Stylus](https://stylus-lang.com/).