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
- 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
1. Create a Gatsby site.
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 --legacy-peer-deps
3. Open the code and start customizing!
Start the site by running
npm run develop.
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 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
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! You can use Real Favicon Generator to generate the image files inside
🤔 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.
To learn more about Gatsby themes specifically, I 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 How-to Guides and Reference items in the primary navigation.
🌟 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.