README.md
1# [Bulma](https://bulma.io)
2
3Bulma 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).
4
5[![npm](https://img.shields.io/npm/v/bulma.svg)][npm-link]
6[![npm](https://img.shields.io/npm/dm/bulma.svg)][npm-link]
7[![Awesome][awesome-badge]][awesome-link]
8[![Join the chat at https://gitter.im/jgthms/bulma](https://badges.gitter.im/jgthms/bulma.svg)](https://gitter.im/jgthms/bulma)
9[![Build Status](https://travis-ci.org/jgthms/bulma.svg?branch=master)](https://travis-ci.org/jgthms/bulma)
10
11<a href="https://bulma.io"><img src="https://raw.githubusercontent.com/jgthms/bulma/master/docs/images/bulma-banner.png" alt="Bulma: a Flexbox CSS framework" style="max-width:100%;" width="600" height="315"></a>
12
13## Quick install
14
15Bulma is constantly in development! Try it out now:
16
17### NPM
18
19```sh
20npm install bulma
21```
22
23**or**
24
25### Yarn
26
27```sh
28yarn add bulma
29```
30
31### Bower
32
33```sh
34bower install bulma
35```
36
37### Import
38After installation, you can import the CSS file into your project using this snippet:
39
40```sh
41import 'bulma/css/bulma.css'
42```
43
44### CDN
45
46[https://cdnjs.com/libraries/bulma](https://cdnjs.com/libraries/bulma)
47
48Feel free to raise an issue or submit a pull request.
49
50## CSS only
51
52Bulma 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)
53
54You can either use that file, "out of the box", or download the Sass source files to customize the [variables](https://bulma.io/documentation/overview/variables/).
55
56There 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.
57
58## Browser Support
59
60Bulma uses [autoprefixer](https://github.com/postcss/autoprefixer) to make (most) Flexbox features compatible with earlier browser versions. According to [Can I use](https://caniuse.com/#feat=flexbox), Bulma is compatible with **recent** versions of:
61
62* Chrome
63* Edge
64* Firefox
65* Opera
66* Safari
67
68Internet Explorer (10+) is only partially supported.
69
70## Documentation
71
72The documentation resides in the [docs](docs) directory, and is built with the Ruby-based [Jekyll](https://jekyllrb.com/) tool.
73
74Browse the [online documentation here.](https://bulma.io/documentation/overview/start/)
75
76## Related projects
77
78| Project | Description |
79|--------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------|
80| [Bulma with Attribute Modules](https://github.com/j5bot/bulma-attribute-selectors) | Adds support for attribute-based selectors |
81| [Bulma with Rails](https://github.com/joshuajansen/bulma-rails) | Integrates Bulma with the rails asset pipeline |
82| [Vue Admin](https://github.com/vue-bulma/vue-admin) | Vue Admin framework powered by Bulma |
83| [Bulmaswatch](https://github.com/jenil/bulmaswatch) | Free themes for Bulma |
84| [Goldfish](https://github.com/Caiyeon/goldfish) | Vault UI with Bulma, Golang, and Vue Admin |
85| [ember-bulma](https://github.com/open-tux/ember-bulma) | Ember addon providing a collection of UI components for Bulma |
86| [Bloomer](https://bloomer.js.org) | A set of React components for Bulma |
87| [React-bulma](https://github.com/kulakowka/react-bulma) | React.js components for Bulma |
88| [Buefy](https://buefy.github.io) | Lightweight UI components for Vue.js based on Bulma |
89| [vue-bulma-components](https://github.com/vouill/vue-bulma-components) | Bulma components for Vue.js with straightforward syntax |
90| [BulmaJS](https://github.com/VizuaaLOG/BulmaJS) | Javascript integration for Bulma. Written in ES6 with a data-* API |
91| [Bulma-modal-fx](https://github.com/postare/bulma-modal-fx) | A set of modal window effects with CSS transitions and animations for Bulma |
92| [Bulma.styl](https://github.com/log1x/bulma.styl) | 1:1 Stylus translation of Bulma |
93| [elm-bulma](https://github.com/surprisetalk/elm-bulma) | Bulma + Elm |
94| [elm-bulma-classes](https://github.com/ahstro/elm-bulma-classes) | Bulma classes prepared for usage with Elm |
95| [Bulma Customizer](https://bulma-customizer.bstash.io/) | Bulma Customizer – Create your own **bespoke** Bulma build |
96| [Fulma](https://mangelmaxime.github.io/Fulma/) | Wrapper around Bulma for [fable-react](https://github.com/fable-compiler/fable-react) |
97| [Laravel Enso](https://github.com/laravel-enso/enso) | SPA Admin Panel built with Bulma, VueJS and Laravel |
98| [Django Bulma](https://github.com/timonweb/django-bulma) | Integrates Bulma with Django |
99| [Bulma Templates](https://github.com/dansup/bulma-templates) | Free Templates for Bulma |
100| [React Bulma Components](https://github.com/couds/react-bulma-components) | Another React wrap on React for Bulma.io |
101| [purescript-bulma](https://github.com/sectore/purescript-bulma) | PureScript bindings for Bulma |
102| [Vue Datatable](https://github.com/laravel-enso/vuedatatable) | Bulma themed datatable based on Vue, Laravel & JSON templates |
103| [bulma-fluent](https://mubaidr.github.io/bulma-fluent/) | Fluent Design Theme for Bulma inspired by Microsoft’s Fluent Design System |
104| [csskrt-csskrt](https://github.com/4d11/csskrt-csskrt) | Automatically add Bulma classes to HTML files |
105| [bulma-pagination-react](https://github.com/hipstersmoothie/bulma-pagination-react) | Bulma pagination as a react component |
106| [bulma-helpers](https://github.com/jmaczan/bulma-helpers) | Functional / Atomic CSS classes for Bulma |
107| [bulma-swatch-hook](https://github.com/hipstersmoothie/bulma-swatch-hook) | Bulma swatches as a react hook and a component |
108| [BulmaWP](https://github.com/tomhrtly/BulmaWP) | Starter WordPress theme for Bulma |
109| [Ralma](https://github.com/aldi/ralma) | Stateless Ractive.js Components for Bulma |
110| [Django Simple Bulma](https://github.com/python-discord/django-simple-bulma) | Lightweight integration of Bulma and Bulma-Extensions for your Django app |
111| [rbx](https://dfee.github.io/rbx) | Comprehensive React UI Framework written in TypeScript. |
112
113## Copyright and license
114
115Code copyright 2019 Jeremy Thomas. Code released under [the MIT license](https://github.com/jgthms/bulma/blob/master/LICENSE).
116
117[npm-link]: https://www.npmjs.com/package/bulma
118[awesome-link]: https://github.com/awesome-css-group/awesome-css
119[awesome-badge]: https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg
120