gatsby-theme-style-guide

v0.17.1

Automatically generate a style guide page based on your Theme UI configuration, built with [`@theme-ui/style-guide`](https://theme-ui.com/packages/style-guide). For more information about how to use this package see README

Latest version published 15 days ago

License: MIT

NPM

GitHub

Package Health Score

90 / 100

security
No known security issues
popularity
Small
maintenance
Healthy
community
Active

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
0.17.1	\|	10/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.16.2	\|	02/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.15.7	\|	03/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.14.7	\|	07/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.13.1	\|	01/2022	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (57)

GitHub Stars: 5.3K
Forks: 673
Contributors: 140

Direct Usage Popularity

The npm package gatsby-theme-style-guide receives a total of 57 downloads a week. As such, we scored gatsby-theme-style-guide popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package gatsby-theme-style-guide, we found that it has been starred 5,300 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 140
Funding: No

A good and healthy external contribution signal for gatsby-theme-style-guide project, which invites more than one hundred open source maintainers to collaborate on the repository.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 49
Open PR: 14
Last Release: 15 days ago
Last Commit: 15 days ago

Further analysis of the maintenance status of gatsby-theme-style-guide based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that gatsby-theme-style-guide demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 5 years
Dependencies: 3 Direct
Versions: 441
Install Size: 11 kB
Dist-tags: 5
# of Files: 16
Maintainers: 4
TS Typings: Yes

gatsby-theme-style-guide has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

gatsby-theme-style-guide

Automatically generate a style guide page based on your Theme UI configuration, built with @theme-ui/style-guide.

npm i gatsby-theme-style-guide

// gatsby-config.js
module.exports = {
  plugins: ['gatsby-plugin-theme-ui', 'gatsby-theme-style-guide'],
}

This theme will create a page at /style-guide that includes typographic styles and colors based on your theme.

Options

module.exports = {
  plugins: [
    'gatsby-plugin-theme-ui',
    {
      resolve: 'gatsby-theme-style-guide',
      options: {
        // sets path for generated page
        basePath: '/design-system',
      },
    },
  ],
}

Shadowing

You can customize the layout and order of the page by shadowing the theme.

component	description
`src/template.js`	the root component for the page
`src/layout.js`	wrapper for adding a page layout
`src/header.js`	header for the top of the page
`src/typography.js`	section for typography styles
`src/colors.js`	section for colors

For example, to shadow the template.js file, you would create a file named your-site/src/gatsby-theme-style-guide/template.js.

gatsby-theme-style-guide dependencies

@theme-ui/style-guide @theme-ui/mdx theme-ui

gatsby-theme-style-guide development dependencies

babel-eslint eslint gatsby react react-dom typescript

FAQs

What is gatsby-theme-style-guide?

Automatically generate a style guide page based on your Theme UI configuration, built with [`@theme-ui/style-guide`](ht... Visit Snyk Advisor to see a full health score report for gatsby-theme-style-guide, including popularity, security, maintenance & community analysis.

Is gatsby-theme-style-guide popular?

The npm package gatsby-theme-style-guide receives a total of 57 weekly downloads. As such, gatsby-theme-style-guide popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is gatsby-theme-style-guide well maintained?

We found that gatsby-theme-style-guide demonstrated a healthy version release cadence and project activity. It has a community of 140 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is gatsby-theme-style-guide safe to use?

The npm package gatsby-theme-style-guide was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 6 November-2024, at 21:32 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (57)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

gatsby-theme-style-guide

Options

Shadowing

gatsby-theme-style-guide dependencies

gatsby-theme-style-guide development dependencies

FAQs

What is gatsby-theme-style-guide?

Is gatsby-theme-style-guide popular?

Is gatsby-theme-style-guide well maintained?

Is gatsby-theme-style-guide safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues