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

@lekoarts/gatsby-theme-styleguide

v5.1.2

Published

Instantly create a styleguide page based on your Theme UI configuration. Zero-config — just install the theme and see your Theme UI config displayed in a beautiful manner.

Downloads

94

Readme

Instantly create a styleguide page based on your Theme UI configuration. Zero-config — just install the theme and see your Theme UI config displayed in a beautiful manner.

Live Preview

Read the Source Code.

Also be sure to check out other Free & Open Source Gatsby Themes and my Personal Website.

Features

  • Automatic styleguide based on your Theme UI configuration
  • Displays colors (individual and palettes), typography (font family, weights, sizes, headings), and a spacing scale
  • Uses @lekoarts/gatsby-theme-specimens under the hood. You can use components from it to extend your styleguide page

Installation

npm install @lekoarts/gatsby-theme-styleguide theme-ui

This theme has theme-ui defined as a peerDependency so make sure to also install it if you don't use it already.

Install as a starter

This will generate a new site that pre-configures the theme including example content and additional plugins.

npx gatsby new gatsby-starter-styleguide https://github.com/LekoArts/gatsby-starter-styleguide

View the starter's code

Usage

Theme options

| Key | Default Value | Description | | ---------- | -------------- | ---------------------- | | basePath | /style-guide | Root url for the theme |

Example usage

// gatsby-config.mjs
const config = {
  plugins: [
    {
      resolve: `@lekoarts/gatsby-theme-styleguide`,
      options: {
          basePath: `/`,
        }
      }
    }
  ]
}

export default config

Shadowing

Please read the guide Shadowing in Gatsby Themes to understand how to customize the theme! Generally speaking you will want to place your files into src/@lekoarts/gatsby-theme-styleguide/ to shadow/override files.

Examples

| Component | Description | | -------------------- | ---------------------------------------------------------------- | | src/template.tsx | Used by createPage function and holds all following components | | src/layout.tsx | Wrapper for adding a page layout (e.g. max-width) | | src/header.tsx | Header for the top of the page ("Style Guide") | | src/colors.tsx | Section for colors | | src/typography.tsx | Section for typography styles | | src/space.tsx | Section for space | | src/footer.tsx | Footer section (holding the theme notice) |

Please keep in mind that you can shadow .tsx files also with .js/.jsx files.

Changelog

You can find the extensive changelog of changes on GitHub. You'll be able to see each patch, minor, and major changes and what pull requests contributed to them.

Questions?

If you have general questions or need help with Gatsby, please go to one of the support platforms mentioned in Gatsby's documentation. If you have a specific question about this theme, you can head to the GitHub Discussions of the repository.

🌟 Supporting me

Thanks for using this project! I'm always interested in seeing what people do with my projects, so don't hesitate to tag me on Twitter and share the project with me.

Please star this project, share it on Social Media or consider supporting me on GitHub Sponsors!