README

@lekoarts/gatsby-theme-styleguide

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.

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 use of the theme.

gatsby new styleguide 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.js
module.exports = {
  plugins: [
    {
      resolve: `@lekoarts/gatsby-theme-styleguide`,
      options: {
          basePath: `/`,
        }
      }
    }
  ]
};

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 Patreon or GitHub Sponsor!

Usage no npm install needed!