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/brand-openedx

v1.2.1

Published

The default branding and SASS theme package containing for Open edX applications. This package is designed to be copied and customized.

Downloads

8,981

Readme

Open edX Brand Package Interface

Warning This package will no longer receive updates. The latest version of this package can be found at https://www.npmjs.com/package/@openedx/brand-openedx

This project contains the default branding assets and style used in Open edX applications. It is published on npm as @edx/brand-openedx.

The file structure serves as an interface to be implemented for custom branding and theming of Open edX.

How to use this package

Applications in Open edX are configured by default to include this package for branding assets and theming visual style.

To use a custom brand and theme...

  1. Fork or copy this project. Ensure that it lives in a location accessible to Open edX applications during asset builds. This may be a published git repo, npm, or local folder depending on your situation.
  2. Replace the assets in this project with your own logos or SASS theme. Match the filenames exactly. Open edX applications refer to these files by their filepath. Refer to the brand for edx.org at https://github.com/edx/brand for an example.
  3. Configure your Open edX instance to consume your custom brand package. Refer to this documentation on configuring the platform: https://docs.openedx.org/projects/openedx-proposals/en/latest/architectural-decisions/oep-0048-brand-customization.html [TODO: Add a link to documentation on configuring in Open edX MFE pipelines when it exists]
  4. Rebuild the assets and microfrontends in your Open edX instance to see the new brand reflected. [TODO: Add link to relevant documentation when it is completed].

Files this package must make available

/logo.svg

logo

/logo-trademark.svg A variant of the logo with a trademark ® or ™. Note: This file must be present. If you don't have a trademark variant of your logo, copy your regular logo and use that.

logo

/logo-white.svg A variant of the logo for use on dark backgrounds

logo

/favicon.ico A site favicon

favicon

/paragon/images/card-imagecap-fallback.png A variant of the default fallback image for [Card.ImageCap] component.

card-imagecap-fallback

/paragon/fonts.scss, /paragon/_variables.scss, /paragon/_overrides.scss A SASS theme for @edx/paragon. Theming documentation in Paragon is coming soon. In the meantime, you can start a theme by the contents of _variables.scss (after line 7) file from the Paragon repository into this file.