.. image:: https://badge.fury.io/js/%40edx%2Fedx-bootstrap.svg :target: https://badge.fury.io/js/%40edx%2Fedx-bootstrap .. highlight:: css
============= edX Bootstrap =============
This library is an extension of
Bootstrap 4 <http://getbootstrap.com>_
for use with edX and openEdX.
npm install --save @edx/edx-bootstrap
Add the following import in your project's base scss file::
Or for Open edX users::
This includes everything you need. Bootstrap is included so you don't need to add it in your project. If you need more control, see the theming section.
Alternatively, you can download this repo and use one of the compiled outputs:
dist/open-edx/theme.css(Open edX bootstrap, extensions, & theme)
dist/edx/theme.css(edX bootstrap, extensions, & theme)
dist/core/core.css(edX bootstrap & extensions only)
The content of a
// Optional @import "my-fonts"; @import "my-variables"; // Required core (includes bootstrap and extensions) @import "@edx/edx-boostrap/scss/core/core.scss"; // The rest of your scss // ...
To create a theme, make a copy of the
scss/open-edx folder in your own project
and make changes. Then include it before you include edx-bootstrap::
@import "fonts"; @import "variables"; // If you are creating your own theme remove // the "../core/core" import with the line below. @import "../core/core"; // @import "@edx/edx-boostrap/scss/core/core.scss"; @import "overrides";
If you’re having trouble, contact the arch squad on Slack:
- edX Internal: #arch-team
The code in this repository uses the Apache 2.0 license unless otherwise noted.
Please see the
LICENSE file <https://github.com/edx/edx-bootstrap/blob/master/LICENSE>_
Documentation details can be found in the
.. _docs index.rst: docs/index.rst
How to Contribute
Contributions are very welcome, but for legal reasons, you must submit a
individual contributor agreement_ before we can accept your
contribution. See our
CONTRIBUTING_ file for more information – it
also contains guidelines for how to maintain high code quality, which
will make your contribution more likely to be accepted.
Reporting Security Issues
Please do not report security issues in public. Please email email@example.com.
.. _individual contributor agreement: https://open.edx.org/wp-content/uploads/2019/01/individual-contributor-agreement.pdf .. _CONTRIBUTING: https://github.com/edx/edx-platform/blob/master/CONTRIBUTING.rst