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.

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

LekoArts

Styleguide

Styleguide is released under the 0BSD license. GitHub Sponsors Website 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. Using the Gatsby Theme @lekoarts/gatsby-theme-styleguide.

Demo Website

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

🚀 Getting Started

Deploy to Gatsby Cloud

1. Create a Gatsby site.

Use git to clone the site and navigate into it:

git clone https://github.com/LekoArts/gatsby-starter-styleguide project-name
cd project-name

2. Install dependencies.

If you use npm 7 or above use the --legacy-peer-deps flag. If you use npm 6 you can use npm install.

npm install --legacy-peer-deps

3. Open the code and start customizing!

Start the site by running npm run develop.

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 check out 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! You can use Real Favicon Generator to generate the image files inside static.

🤔 Questions or problems?

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 project, you can head to the GitHub Discussions of the repository.

🎓 Learning Gatsby

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

Themes

To learn more about Gatsby themes specifically, I 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 or GitHub Sponsor!

About

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.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published