mirror of
https://github.com/jgthms/bulma.git
synced 2024-11-14 11:14:24 +00:00
5c339b7b7c
* Added how-to README.md file to docs/ directory; and referenced the docs directory in the main README.md. * Made requested changes from jgthms. * made requested changes
68 lines
2.4 KiB
Markdown
68 lines
2.4 KiB
Markdown
# [Bulma](http://bulma.io)
|
|
|
|
[](https://www.npmjs.com/package/bulma)
|
|
[](https://www.npmjs.com/package/bulma)
|
|
[](https://gitter.im/jgthms/bulma)
|
|
|
|
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).
|
|
|
|
[](http://bulma.io)
|
|
|
|
## Quick install
|
|
|
|
Bulma is in early but active development! Try it out now:
|
|
|
|
### NPM
|
|
|
|
```sh
|
|
npm install bulma
|
|
```
|
|
|
|
### Bower
|
|
|
|
```sh
|
|
bower install bulma
|
|
```
|
|
|
|
### CDN
|
|
|
|
[https://cdnjs.com/libraries/bulma](https://cdnjs.com/libraries/bulma)
|
|
|
|
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
|
|
|
|
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:
|
|
|
|
* Chrome
|
|
* Edge
|
|
* Firefox
|
|
* Internet Explorer (10+)
|
|
* Opera
|
|
* Safari
|
|
|
|
## 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/)
|
|
|
|
## Related projects
|
|
|
|
* Bulma with Attribute Modules: https://github.com/j5bot/bulma-attribute-selectors
|
|
* Bulma with Rails: https://github.com/joshuajansen/bulma-rails
|
|
* iTemplate: [http://itemplate.ga/](http://itemplate.ga/dashboard.html)
|
|
* Vue Admin powered by Bulma: https://github.com/vue-bulma/vue-admin
|
|
|
|
## Copyright and license
|
|
|
|
Code copyright 2017 Jeremy Thomas. Code released under [the MIT license](https://github.com/jgthms/bulma/blob/master/LICENSE).
|