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
Also be sure to checkout other Free & Open Source Gatsby Themes
- Automatic styleguide based on your Theme UI configuration
- Displays colors (individual and palettes), typography (font family, weights, sizes, headings), and a spacing scale
@lekoarts/gatsby-theme-specimensunder the hood. You can use components from it to extend your styleguide page
🚀 Getting Started
- 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
- Start developing.
Navigate into your new site's directory and start it up.
cd project-name gatsby develop
- Open the code and start customizing!
Your site is now running at
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
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.
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.
- To learn more about Gatsby themes specifically, we recommend checking out the theme docs.
For most developers, I recommend starting with the in-depth tutorial for creating a site with Gatsby. It starts with zero assumptions about your level of ability and walks through every step of the process.
To dive straight into code samples, head to Gatsby's documentation. In particular, check out the Reference Guides and Gatsby API sections in the sidebar.
🌟 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!