Skip to content
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.
JavaScript
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update gatsby-starter-styleguide from LekoArts/gatsby-themes Dec 31, 2019
src Update gatsby-starter-styleguide from LekoArts/gatsby-themes Dec 31, 2019
static Update gatsby-starter-styleguide from LekoArts/gatsby-themes Dec 31, 2019
.gitignore Update gatsby-starter-styleguide from LekoArts/gatsby-themes Dec 31, 2019
CHANGELOG.md
LICENSE initial Dec 31, 2019
README.md
gatsby-config.js Update gatsby-starter-styleguide from LekoArts/gatsby-themes Dec 31, 2019
package.json
yarn.lock Update gatsby-starter-styleguide from LekoArts/gatsby-themes Jan 17, 2020

README.md

LekoArts

Styleguide

Styleguide is released under the MIT license. PRs welcome! Follow @lekoarts_de Netlify Status

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. Using the Gatsby Theme @lekoarts/gatsby-theme-styleguide.

Demo Website

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

🚀 Getting Started

  1. Create a Gatsby site.

Use the Gatsby CLI to create a new site, specifying this project

gatsby new project-name https://github.com/LekoArts/gatsby-starter-styleguide
  1. Start developing.

Navigate into your new site's directory and start it up.

cd project-name
gatsby develop
  1. Open the code and start customizing!

Your site is now running at http://localhost:8000!

If you want to learn more about how you can use a Gatsby starter that is configured with a Gatsby theme, you can checkout this shorter or longer tutorial. The tutorials don't exactly apply to this starter however the concepts are the same.

📝 Using and modifying this starter

Important Note: Please read the guide Shadowing in Gatsby Themes to understand how to customize the underlying theme!

This starter creates a new Gatsby site that installs and configures the theme @lekoarts/gatsby-theme-styleguide.

Have a look at the theme's README and files to see what options are available and how you can shadow the various components. Generally speaking you will want to place your files into src/@lekoarts/gatsby-theme-styleguide/ to shadow/override files.

Change your static folder

The static folder contains the icons, social media images and robots.txt. Don't forget to change these files, too!

🤔 Questions or problems?

Please open up an issue on the main repository: LekoArts/gatsby-themes. Thanks!

🎓 Learning Gatsby

Looking for more guidance? Full documentation for Gatsby lives on Gatsby's website.

Themes

  • To learn more about Gatsby themes specifically, we recommend checking out the theme docs.

General

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