Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/doximity/vital
Design Framework
https://github.com/doximity/vital
compile-font-icons css css-framework rubygems
Last synced: 3 months ago
JSON representation
Design Framework
- Host: GitHub
- URL: https://github.com/doximity/vital
- Owner: doximity
- License: other
- Created: 2016-02-06T01:00:43.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-04-18T13:32:35.000Z (7 months ago)
- Last Synced: 2024-07-07T13:07:16.969Z (4 months ago)
- Topics: compile-font-icons, css, css-framework, rubygems
- Language: Sass
- Homepage: http://vitalcss.com
- Size: 2.41 MB
- Stars: 55
- Watchers: 96
- Forks: 2
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- Awesome-CSS-Resources - Vital:
README
**Note:** Vital v2.x is not backwards compatible with v1.x. Some things may break. You may need to do some refactoring.
# Vital
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 |
## Usage
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](http://vitalcss.com/get-started/) for information on installation methods, framework contents, templates, examples and more.
## Development
**NOTE**: The project requires Ruby 2.0+ for building its assets and documentation.
Initial setup:
```sh
git clone https://github.com/doximity/vital.git
cd vital
bundle
# If you want to build / work on documentation
cd docs
bundle
```
### Compiling assets locally
```sh
cd vital
bundle exec rake vital:build
```
### Build the documentation
Vital is built using a simple static generator: https://middlemanapp.com/
```sh
cd vital/docs
bundle
bundle exec middleman
```
## Publishing
Publishing and deployment should be performed by a Doximity member.
## Contributing
See [CONTRIBUTING.md](./CONTRIBUTING.md)
## Releasing a new version
- 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 the `Gemfile.lock` file
- `git add ...` all of the updated files
- `git commit -m 'vX.Y.Z'`
- Create a branch, get it approved, merge the branch and checkout `master`
- `bundle exec rake release` to push to RubyGems
- `npm 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
## Reporting Issues and Suggestions
Please submit GitHub issues for problems with the library. Also, feel free to submit a pull-request with suggested changes.