diff --git a/Readme.md b/Readme.md index 531a1754b..06902f754 100644 --- a/Readme.md +++ b/Readme.md @@ -8,6 +8,44 @@ 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](https://opencollective.com/stylus/) os [paypal](https://www.paypal.com/paypalme/iChenLei/) ! + + + + + + + + + + + + +
+ + automattic + + + + mojotech + +
+

Your Logo

+
+ + opencollective stylus + + or + + Paypal stylus + +
+ +### Backers +[![Backers](https://opencollective.com/stylus/individuals.svg)](https://opencollective.com/stylus/) + ## Installation ```bash @@ -21,181 +59,32 @@ stylus -w style.styl -o style.css ``` You can also [try all stylus features on stylus-lang.com](http://stylus-lang.com/try.html), build something with stylus on [codepen](http://codepen.io) or [RunKit](https://npm.runkit.com/stylus) -### IDE/Editor Support - -| IDE/Editor | built-in support | guide | plugin support | -| ------------- | ------------- | ------------- | ------------- | -| WebStorm | ✅  [bug report](https://youtrack.jetbrains.com/issues/WEB) | [Using stylus with webstorm](https://www.jetbrains.com/help/webstorm/transpiling-stylus-to-css.html) | N/A | -| VSCode | ❌ | N/A | [Stylus](https://marketplace.visualstudio.com/items?itemName=sysoev.language-stylus)(maintainer: [@iChenLei](https://github.com/ichenlei) [@d4rkr00t](https://github.com/d4rkr00t)) | -| Sublime 2/3 | ❌ | N/A |[Stylus](https://packagecontrol.io/packages/Stylus)(maintainer: [@billymoon](https://github.com/billymoon)) | -| Atom | ❌ | N/A | [Stylus](https://atom.io/packages/stylus)(maintainer: [@matthojo](https://github.com/matthojo)) | -| Vim | ❌ | N/A | [vim-stylus](https://github.com/iloginow/vim-stylus)(maintainer: [@iloginow](https://github.com/iloginow)) | - -> Missing your favorite IDE/Editor support ? Please report to us via [stylus issues](https://github.com/stylus/stylus/issues) - -### Modern bundler/task-runner Support - -| Bundler | built-in support | guide | plugin support | -| ------------- | ------------- | ------------- | ------------- | -| webpack | ✅ | [Using stylus with webpack](https://webpack.js.org/loaders/stylus-loader/) | [stylus-loader](https://github.com/webpack-contrib/stylus-loader) | -| vite | ✅ | [Using stylus with vite](https://vitejs.dev/guide/features.html#css-pre-processors) | N/A | -| parcel | ✅ | [Using stylus with parcel v1](https://parceljs.org/stylus.html) \| [v2](https://v2.parceljs.org/languages/stylus/) | N/A | -| fuse-box | ✅ | [Using stylus with fuse-box](https://fuse-box.org/docs/plugins/stylus-plugin) | N/A | -| snowpack | ❌ | [Snowpack plugins guide](https://www.snowpack.dev/reference/plugins) | [snowpack-plugin-stylus](https://github.com/fansenze/snowpack-plugin-stylus) | -| gulp | ❌ | N/A | [gulp-stylus](https://github.com/stevelacy/gulp-stylus) | -| grunt | ❌ | N/A | [grunt-contrib-stylus](https://github.com/gruntjs/grunt-contrib-stylus) | -| rollup | ❌ | N/A | [rollup-plugin-stylus-compiler](https://github.com/RJHwang/rollup-plugin-stylus-compiler) | - - -> Missing your favorite modern bundler/task-runner support ? Please report to us via [stylus issues](https://github.com/stylus/stylus/issues) +### 📖 New Docs (alpha) -### Example - -```stylus -border-radius() - -webkit-border-radius: arguments - -moz-border-radius: arguments - border-radius: arguments - -body a - font: 12px/1.4 "Lucida Grande", Arial, sans-serif - background: black - color: #ccc - -form input - padding: 5px - border: 1px solid - border-radius: 5px -``` - -compiles to: - -```css -body a { - font: 12px/1.4 "Lucida Grande", Arial, sans-serif; - background: #000; - color: #ccc; -} -form input { - padding: 5px; - border: 1px solid; - -webkit-border-radius: 5px; - -moz-border-radius: 5px; - border-radius: 5px; -} -``` - -the following is equivalent to the indented version of Stylus source, using the CSS syntax instead: - -```stylus -border-radius() { - -webkit-border-radius: arguments - -moz-border-radius: arguments - border-radius: arguments -} - -body a { - font: 12px/1.4 "Lucida Grande", Arial, sans-serif; - background: black; - color: #ccc; -} - -form input { - padding: 5px; - border: 1px solid; - border-radius: 5px; -} -``` - -### Features - - Stylus has _many_ features. Detailed documentation links follow: - - - [css syntax](docs/css-style.md) support - - [mixins](docs/mixins.md) - - [keyword arguments](docs/kwargs.md) - - [variables](docs/variables.md) - - [interpolation](docs/interpolation.md) - - arithmetic, logical, and equality [operators](docs/operators.md) - - [importing](docs/import.md) of other stylus sheets - - [introspection api](docs/introspection.md) - - type coercion - - [@extend](docs/extend.md) - - [conditionals](docs/conditionals.md) - - [iteration](docs/iteration.md) - - nested [selectors](docs/selectors.md) - - parent reference - - in-language [functions](docs/functions.md) - - [variable arguments](docs/vargs.md) - - built-in [functions](docs/bifs.md) (over 60) - - optional [image inlining](docs/functions.url.md) - - optional compression - - JavaScript [API](docs/js.md) - - extremely terse syntax - - stylus [executable](docs/executable.md) - - [error reporting](docs/error-reporting.md) - - single-line and multi-line [comments](docs/comments.md) - - css [literal](docs/literal.md) - - character [escaping](docs/escape.md) - - [@keyframes](docs/keyframes.md) support & expansion - - [@font-face](docs/font-face.md) support - - [@media](docs/media.md) support - - Connect [Middleware](docs/middleware.md) - - TextMate [bundle](docs/textmate.md) - - Coda/SubEtha Edit [Syntax mode](https://github.com/atljeremy/Stylus.mode) - - gedit [language-spec](docs/gedit.md) - - VIM [Syntax](https://github.com/iloginow/vim-stylus) - - Espresso [Sugar](https://github.com/aljs/Stylus.sugar) - - [Firebug extension](docs/firebug.md) - - heroku [web service](http://styl.herokuapp.com/) for compiling stylus - - [style guide](https://github.com/lepture/ganam) parser and generator - - transparent vendor-specific function expansion +Try our new [official documentation website](http://stylus-docs.netlify.app/) and give us feedback via [github issues](https://github.com/stylus/stylus/issues), thanks. ### Community modules - https://github.com/stylus/stylus/wiki -### Contribution Guide - -Please read our [Contribution Guide](Contributing.md) before making any pull requests to the project. Included are directions for opening issues, workflows, and coding standards. - ### Stylus cheatsheet - [Stylus cheatsheet](https://devhints.io/stylus), very useful stylus syntax code snippet for you -### Authors +### Code of Conduct - - [TJ Holowaychuk (tj)](https://github.com/tj) +Please note that this project is released with a [Contributor Code of Conduct](Code_of_Conduct.md). By participating in this project you agree to abide by its terms. -### More Information +### Contribution - - Language [comparisons](docs/compare.md), compare Less Sass and Stylus. +Please read our [Contribution Guide](Contributing.md) before making any pull requests to the project. Included are directions for opening issues, workflows, and coding standards. -## Code of Conduct +Thank you to all the people who already contributed to Stylus! -Please note that this project is released with a [Contributor Code of Conduct](Code_of_Conduct.md). By participating in this project you agree to abide by its terms. + ## License -(The MIT License) - -Copyright (c) Automattic <developer.wordpress.com> - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -'Software'), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. +[MIT](https://github.com/stylus/stylus/blob/dev/LICENSE) -THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +Copyright (c) 2010-present [TJ](https://github.com/tj) and [Stylus maintainers](https://github.com/orgs/stylus/people)