Skip to content
Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
src
.npmignore
CHANGELOG.md
README.md
gatsby-config.js
gatsby-node.js
index.js
package.json

README.md

Gatsby Theme

@lekoarts/gatsby-theme-styleguide

@lekoarts/gatsby-theme-styleguide is released under the MIT license. Current npm package version. Downloads per month on npm. Total downloads on npm. PRs welcome! Follow @lekoarts_de

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 checkout other Free & Open Source Gatsby Themes

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

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 this 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.

🌟 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!

If you want to hire me for contract/freelance work, you can do so! Get in touch with me!

You can’t perform that action at this time.