bulma/README.md

88 lines
4.7 KiB
Markdown
Raw Normal View History

2016-01-24 00:03:43 +00:00
# [Bulma](http://bulma.io)
2016-03-09 22:10:26 +00:00
[![npm](https://img.shields.io/npm/v/bulma.svg)](https://www.npmjs.com/package/bulma)
[![npm](https://img.shields.io/npm/dm/bulma.svg)](https://www.npmjs.com/package/bulma)
2016-04-16 20:50:48 +00:00
[![Join the chat at https://gitter.im/jgthms/bulma](https://badges.gitter.im/jgthms/bulma.svg)](https://gitter.im/jgthms/bulma)
2016-03-09 22:10:26 +00:00
2016-01-24 00:03:43 +00:00
Bulma is a modern CSS framework based on [Flexbox](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Flexible_Box_Layout/Using_CSS_flexible_boxes).
2016-09-24 16:18:56 +00:00
[![Bulma: a Flexbox CSS framework](https://raw.githubusercontent.com/jgthms/bulma/master/docs/images/bulma-banner.png)](http://bulma.io)
2016-01-27 00:33:07 +00:00
## Quick install
Bulma is in early but active development! Try it out now:
2016-03-09 22:10:26 +00:00
### NPM
2016-04-16 20:50:48 +00:00
```sh
2016-02-13 20:13:35 +00:00
npm install bulma
```
**or**
### YARN
```sh
yarn add bulma
```
2016-01-27 00:33:07 +00:00
### Bower
```sh
bower install bulma
```
2016-03-09 22:10:26 +00:00
### CDN
[https://cdnjs.com/libraries/bulma](https://cdnjs.com/libraries/bulma)
2016-03-09 22:10:26 +00:00
Feel free to raise an issue or submit a pull request.
## CSS only
Bulma is a **CSS** framework. As such, the sole output is a single CSS file: [bulma.css](https://github.com/jgthms/bulma/blob/master/css/bulma.css)
You can either use that file, "out of the box", or download the Sass source files to customize the [variables](http://bulma.io/documentation/overview/variables/).
There is **no** JavaScript included. People generally want to use their own JS implementation (and usually already have one). Bulma can be considered "environment agnostic": it's just the style layer on top of the logic.
## Browser Support
2017-04-02 16:46:37 +00:00
Bulma uses [autoprefixer](https://github.com/postcss/autoprefixer) to make (most) Flexbox features compatible with earlier browser versions. According to [Can I use](http://caniuse.com/#feat=flexbox), Bulma is compatible with **recent** versions of:
2016-03-09 22:10:26 +00:00
2016-04-10 16:25:27 +00:00
* Chrome
* Edge
* Firefox
* Opera
* Safari
2016-01-27 00:33:07 +00:00
2017-04-02 16:46:37 +00:00
Internet Explorer (10+) is only partially supported.
## Documentation
The documentation resides in the [docs](docs) directory, and is built with the Ruby-based [Jekyll](https://jekyllrb.com/) tool.
Browse the [online documentation here.](http://bulma.io/documentation/overview/start/)
2016-05-30 18:36:17 +00:00
## Related projects
| Project | Description |
|------------------------------------------------------------------------------------|--------------------------------------------------------------------|
| [Bulma with Attribute Modules](https://github.com/j5bot/bulma-attribute-selectors) | Adds support for attribute-based selectors. |
| [Bulma with Rails](https://github.com/joshuajansen/bulma-rails) | Integrates Bulma with the rails asset pipeline |
| [iTemplate](http://itemplate.ga/) | Admin Dashboard based on Bulma |
| [Vue Admin](https://github.com/vue-bulma/vue-admin) | Vue Admin framework powered by Bulma |
| [Bulmaswatch](https://github.com/jenil/bulmaswatch) | Free themes for Bulma |
| [Goldfish](https://github.com/Caiyeon/goldfish) | Vault UI with Bulma, Golang, and Vue Admin |
| [ember-bulma](https://github.com/open-tux/ember-bulma) | Ember addon providing a collection of UI components for Bulma |
| [Bloomer](https://bloomer.js.org) | A set of React components for Bulma |
| [Re-bulma](https://github.com/bokuweb/re-bulma) | Bulma components build with React |
| [React-bulma](https://github.com/kulakowka/react-bulma) | React.js components for Bulma |
| [Buefy](https://buefy.github.io) | Lightweight UI components for Vue.js based on Bulma |
| [vue-bulma-components](https://github.com/vouill/vue-bulma-components) | Bulma components for Vue.js with straightforward syntax |
| [BulmaJS](https://github.com/VizuaaLOG/BulmaJS) | Javascript integration for Bulma. Written in ES6 with a data-* API |
| [Bulma.styl](https://github.com/log1x/bulma.styl) | 1:1 Stylus translation of Bulma |
2016-05-30 18:36:17 +00:00
2016-01-24 00:03:43 +00:00
## Copyright and license
2017-01-15 21:14:27 +00:00
Code copyright 2017 Jeremy Thomas. Code released under [the MIT license](https://github.com/jgthms/bulma/blob/master/LICENSE).