bulma/README.md

75 lines
3.0 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
```
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
* Bulma with Attribute Modules: https://github.com/j5bot/bulma-attribute-selectors
* Bulma with Rails: https://github.com/joshuajansen/bulma-rails
2016-09-11 14:21:04 +00:00
* iTemplate: [http://itemplate.ga/](http://itemplate.ga/dashboard.html)
2017-03-05 19:43:04 +00:00
* Vue Admin powered by Bulma: https://github.com/vue-bulma/vue-admin
2017-03-24 22:10:20 +00:00
* Bulmaswatch — Free themes for Bulma: https://github.com/jenil/bulmaswatch
* Goldfish — Vault UI with Bulma, Golang, and Vue Admin: https://github.com/Caiyeon/goldfish
2017-06-25 09:36:53 +00:00
* Bloomer — A set of React components for Bulma: https://bloomer.js.org
2017-06-24 23:18:14 +00:00
* Re-bulma Bulma components build with React: https://github.com/bokuweb/re-bulma
* React-bulma React.js components for bulma: https://github.com/kulakowka/react-bulma
2017-06-29 18:43:08 +00:00
* Buefy — Lightweight UI components for Vue.js based on Bulma: https://buefy.github.io
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).