Skip to content

lazaronixon/css-zero

Repository files navigation

CSS Zero

An opinionated CSS starter kit for your Ruby on Rails application. You can think of it like a "no build" Tailwind CSS.

Installation

Add this gem to your project.

bundle add css-zero

Run the install command.

bin/rails generate css_zero:install

Add the additional components you need. (Optional)

bin/rails generate css_zero:add --help

Usage

<h1 class="text-xl font-bold mb-4">
  Write most page content using utility classes.
</h1>

<div class="custom-component">
  Create components using CSS variables.
</div>

<div class="card">
  Optionally, copy pre-built components into your application.
</div>
.custom-component {
  background-color: var(--red-500);
  border-radius: var(--rounded);
  block-size: var(--size-4);
}

Check the CSS files in the repository to see the available variables and utility classes.

Components

Icons

Some icons in the examples are not copied to the project. If you are looking for good ones, I recommend Lucide.

Scaffold

This gem implements custom templates for scaffolds and authentication.

Development

To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/lazaronixon/css-zero. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the CSS Zero project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.