stylus README

The project's README from github.com/stylus/stylus. As one markdown file: README.md.

Stylus logo

Build Status Maintenance npm version npm Join the community on github discussion

Stylus is a revolutionary new language, providing an efficient, dynamic, and expressive way to generate CSS. Supporting both an indented syntax and regular CSS style.

Sponsors

You can sponsor stylus ongoing development via opencollective or paypal !

automattic mojotech

Your Logo

Paypal stylus

Backers

Backers

Installation

$ npm install stylus -g

Basic Usage

Watch and compile a stylus file from command line with

stylus -w style.styl -o style.css

You can also try all stylus features on stylus-lang.com, build something with stylus on codepen or RunKit

Community modules

Stylus cheatsheet

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Contribution

Please read our Contribution Guide before making any pull requests to the project. Included are directions for opening issues, workflows, and coding standards.

Thank you to all the people who already contributed to Stylus!

License

MIT

Copyright (c) 2010-present TJ and Stylus maintainers

stylus (stylus/stylus)

Searching Database…

11.3K ·GitHub
What is this?Stylus is a CSS preprocessor language for Node.js that lets you write stylesheets with an expressive, dynamic syntax (indented or regular CSS-style) and compiles them down to plain CSS.
Is it a CLI tool or a library I import into my build?Both: Stylus ships as a Node.js library you can require in your build pipeline and as a command-line tool for watching and compiling .styl files directly.
How do I add it to a project?Install it via npm and either require it in your Node code or run it from the command line to watch and compile a .styl file into CSS.
Do I need anything special installed first?Just Node.js (version 16 or newer) and npm; Stylus itself depends on small libraries like glob, sax, and source-map internally.
Can I try it without installing anything?Yes, Stylus has an online playground at stylus-lang.com and can also be tried on CodePen or RunKit without a local setup.
How is Stylus different from writing plain CSS?Stylus adds variables, mixins, functions, and an optional indentation-based syntax (no braces or semicolons required), making stylesheets more dynamic and less repetitive than plain CSS.
Is there a cheatsheet for the syntax?Yes, the README links to a community-maintained Stylus cheatsheet with handy syntax snippets.
Can I extend Stylus with third-party modules?Yes, the README points to a list of community modules that extend Stylus functionality beyond the core.
Creator
stylus
Size
7.3 MB
Stars
11.3K
Age
15y
Commits · 90 Days