Note: Vital v2.x is not backwards compatible with v1.x. Some things may break. You may need to do some refactoring.
A minimally invasive CSS framework for modern web applications.
- Vital is a reverse approach to "everything and the kitchen sink" CSS frameworks.
- Built with Sass and Slim for readability and maintainability.
- No ridiculous amounts of classes or nesting. No excessively buried code.
- Written almost entirely in em values, allowing for easy and consistent scaling.
- Small:
Size | Gzipped | |
---|---|---|
Javascripts | 0 | |
Vital CSS | 23 KB | 6 KB |
A couple installation options are available:
- Download the latest release tarball from https://github.com/doximity/vital/releases.
- Install the
vital
RubyGem, NPM or Bower package on your project. - Use a precompiled release from RawGit.
Check out our docs for information on installation methods, framework contents, templates, examples and more.
NOTE: The project requires Ruby 2.0+ for building its assets and documentation.
Initial setup:
git clone https://github.com/doximity/vital.git
cd vital
bundle
# If you want to build / work on documentation
cd docs
bundle
cd vital
bundle exec rake vital:build
Vital is built using a simple static generator: https://middlemanapp.com/
cd vital/docs
bundle
bundle exec middleman
Publishing and deployment should be performed by a Doximity member.
See CONTRIBUTING.md
- Ensure docs,
README.md
,CHANGELOG.md
are up to date - Bump version on
lib/vital/version.rb
- Bump version on
package.json#L3
bundle exec rake vital:build
bundle
, commit and push theGemfile.lock
filegit add ...
all of the updated filesgit commit -m 'vX.Y.Z'
- Create a branch, get it approved, merge the branch and checkout
master
bundle exec rake release
to push to RubyGemsnpm publish
to push to NPM- Go to https://github.com/doximity/vital/releases and create a new release with the tarball attached
- In Slack, run
doxbot ship vital
to deploy documentation site - Visit http://vitalcss.s3-website-us-east-1.amazonaws.com and http://vitalcss.com and ensure it has been updated
Please submit GitHub issues for problems with the library. Also, feel free to submit a pull-request with suggested changes.