npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@edx/edx-bootstrap

v2.6.0

Published

The Bootstrap theme for Open edX

Downloads

13,628

Readme

.. 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.

Installation

Using npm::

npm install --save @edx/edx-bootstrap

Usage

Add the following import in your project's base scss file::

@import "~@edx/edx-bootstrap/scss/edx/theme.scss";

Or for Open edX users::

@import "~@edx/edx-bootstrap/scss/open-edx/theme.scss";

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)

Theming

The content of a theme.scss file::

// 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";

Getting Help

If you’re having trouble, you can ask in the front-end channel on Slack or contact the Frontend Working Group:

  • #front-end <https://openedx.slack.com/messages/C0EUBSV7D>_
  • #frontend-working-group <https://openedx.slack.com/messages/C02BMP2RD5Y>_

License

The code in this repository uses the Apache 2.0 license unless otherwise noted. Please see the LICENSE file <https://github.com/openedx/edx-bootstrap/blob/master/LICENSE>_ for details.

Documentation

Documentation details can be found in the docs index.rst_.

.. _docs index.rst: docs/index.rst

How to Contribute

Contributions are very welcome, but for legal reasons, you must submit a signed 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 protected].

.. _individual contributor agreement: https://open.edx.org/wp-content/uploads/2019/01/individual-contributor-agreement.pdf .. _CONTRIBUTING: https://github.com/openedx/.github/blob/master/CONTRIBUTING.md