encre-css

A TailwindCSS-compatible utility-first CSS generation library written in Rust

MIT License Pipeline status Coverage report Dependency status Published on crates.io Documentation on docs.rs
Number of files Number of lines of code Number of lines of comments Total number of lines
## Table of contents - [A brief introduction to utility-first CSS frameworks](#a-brief-introduction-to-utility-first-css-frameworks) - [Getting started](#getting-started) - [Command line interface](#command-line-interface) - [About the name](#about-the-name) - [License](#license) ## A brief introduction to utility-first CSS frameworks Traditionally, whenever you need to style something on the web, you write CSS in a dedicated file and apply the rules using classes in your HTML, like that: ```html
A new Javascript library has been released!
The library react has just been released, did you know it? It is a JavaScript library for creating user interfaces.
Dismiss Try it here!
``` However styling this way is pretty boring because you need to think about good class names and to repeatedly switch between several files, it could be better. Utility-first CSS frameworks takes a new approach by using minimal and pre-defined class names directly linked to its CSS rule content. The CSS file will then be generated [on-demand](https://antfu.me/posts/reimagine-atomic-css#on-demand-way) allowing the classes to be very flexible and customizable. This approach lets you quickly prototype visual HTML elements and encourages you to turn them into components using your favorite web framework. It also makes building a responsive website easier and forces it to be closer to your design system (if you have one): ```html
A new Javascript library has been released!
The library react has just been released, did you know it? It is a JavaScript library for creating user interfaces.
Dismiss Try it here!
``` There is already a lot of utility-first frameworks like [Tailwind CSS](https://tailwindcss.com), [Windi CSS](https://windicss.org), [Twind](https://twind.dev) and [Uno CSS](https://uno.antfu.me), but `encre-css` is unique because it is written in Rust and uses a new architecture, making it **the fastest utility-first framework** (according to the benchmark [here](https://gitlab.com/encre-org/encre-css-bench) based on [Uno CSS' benchmark](https://github.com/unocss/unocss/tree/main/bench)). ## Getting started Add `encre-css` to your `Cargo.toml`: ```toml [dependencies] encre-css = "0.14.1" ``` Generating styles takes two steps: - You need to _configure_ the CSS generation by making a `Config` structure. It can be created by reading a [TOML](https://toml.io) file using `Config::from_file` or by using the default values with `Config::default`; - Then, you need to _generate the styles_ based on some sources using the `generate` function. This function will scan the content of the sources, extract atomic classes and generate the style needed for each class. ### Example ```rust use encre_css::Config; let config = Config::default(); let css = encre_css::generate( [r#"

Hello world!

"#], &config, ); assert!(css.expect("failed to generate the CSS").ends_with(r#" .w-auto { width: auto; } .rounded-md { border-radius: 0.375rem; } .bg-red-200 { --en-bg-opacity: 1; background-color: rgb(254 202 202 / var(--en-bg-opacity)); }"#)); ``` ## Command line interface A command line interface is also available. Install it using: ```bash cargo install encre-css-cli ``` Then run `encrecss --help` for instructions on how to use it. ## Plugins `encre-css` was built with modularity in mind and it is possible to write or use custom plugins. [Learn more](https://docs.rs/encre-css/latest/encre_css/plugins) ## About the name `encre` means `ink` in French. ## License `encre-css` is published under the [MIT license](https://gitlab.com/encre-org/encre-css/blob/main/LICENSE).