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

brandai-docs-plugin

v1.0.2

Published

Library to integrate design system documentation websites with Brand.ai (https://brand.ai).

Downloads

7

Readme

Design system documentation - Brand.ai integration

Connect your design system documentation to your live style data using the Brand.ai documentation plugin.

When a style changes in Brand.ai, your design system documentation will immediately reflect the change.

How it works

Data attributes api

Attribute: data-color

Sets text color

<div data-color="link">some link</div> <!-- set text color based on 'Link' color asset -->

Attribute: data-background-color

Sets background-color

<div data-background-color="primary"> <!-- set background color based on 'Primary' color asset -->

Attribute: data-typography

Sets font style properties: font-family, font-size, font-style, font-weight, text-align, line-height, background-color and color

<h1 data-typography="primary header"></h1> <!-- set the above properties  based on 'Primary Header' typography asset -->

Note: Fonts are expected to be loaded for correct font family to be rendered.

Attribute: data-image-src

Sets src on img elements

<img data-image-src="inverted logo"/> <!-- set src based on 'Inverted Logo' logo asset -->

Note: all items from logos, icons and images sections can be used as valid data-image-src values

Attribute: data-background-image

Sets background-image url() value

<div data-background-image="trash"/> <!-- set url based on 'Trash' icon asset -->

Note: all items from logos, icons and images sections can be used as valid data-background-image values

or

Download directly

CommonJS:

var BrandAiDocsPlugin = require('brandai-docs-plugin');

// Create plugin instance.
// After creation it will fetch your style data and update elements with matching data attributes
var brandAiDocsPlugin = new BrandAiDocsPlugin("<%= apiUrl %>");

Native Javascript:

<script src="https://downloads.brand.ai/brandai-docs-plugin-1.0.0.min.js"></script>

// Create plugin instance.
// After creation it will fetch your style data and update elements with matching data attributes
var brandAiDocsPlugin = new window.BrandAiDocsPlugin("<%= apiUrl %>");

AMD:

define(['BrandAIDocsPlugin', function(BrandAiDocsPlugin){
   // Create plugin instance.
   // After creation it will fetch your style data and update elements with matching data attributes
   var brandAiDocsPlugin = new BrandAiDocsPlugin("<%= apiUrl %>");
...
}]

How to update your documentation with style data upon Dom changes:

//If you changed you dom structure, you can use the plugin to reflect those changes (cached style data will be used)
brandAiDocsPlugin.refreshStyleData();