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

@themecraftstudio/stylish

v0.5.0

Published

Stylish ===========================

Downloads

23

Readme

Stylish

Modular and minimalist SCSS toolkit empowering vanilla CSS development.

Usage

Configure your package manager to use GitHub's npm registry, then @use the module as you normally would:

@use './path/to/node_modules/@themecraftstudio/stylish' as util;

or

@use './path/to/node_modules/@themecraftstudio/stylish/reset';
@use './path/to/node_modules/@themecraftstudio/stylish/device';

You'll likely want to include classes and rules defined by this module in your above-the-fold stylesheets.

Colors

Define your color palette as variables in a module:

// ui/_colors.scss
$red: #d6001c;
$brown: #3a2c24;

Then pass them to stylish/colors as such:

// main.scss
@use 'ui/colors' as colors;
@use 'sass:meta';
@use './path/to/node_modules/@themecraftstudio/stylish/colors' as color-helper with (
  $colors: meta.module-variables('colors'),
);

@include color-helper.classes;
@include color-helper.rules;

The classes mixin generates color classes using the pattern color-<name>, whereas the rules mixin adds CSS custom properties named --color-<name> to the document element (html). This allows you to override these custom properties through the higher specificity :root pseudo-class.

Reset

@use './path/to/node_modules/@themecraftstudio/stylish/reset';

@include reset.styles;

Device

TODO document mixins, functions, variables

Debug

All debug mixins are gated by the isWip function that must be defined through the Javascript API. For instance:

const sass = require('sass');

sass.compile('front.scss', {
    functions: {
        isWip: () => {
            return process.env.WIP ? 
                dartSass.types.Boolean.TRUE : 
                dartSass.types.Boolean.FALSE
            ;
        }
    }
});

Design philosophy

  • minimalistic: does not define any visual or typographic style
  • modularity: authors shall be allowed to include only the rules they need;
  • mixins do not define any classes;
  • semantic classes must be explicitly included via *-classes mixins.

Related Work