Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lekoarts/gatsby-starter-styleguide
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.
https://github.com/lekoarts/gatsby-starter-styleguide
gatsby gatsby-themes style-guide styleguide theme-ui
Last synced: 22 days ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/lekoarts/gatsby-starter-styleguide
- Owner: LekoArts
- License: 0bsd
- Created: 2019-12-31T15:10:35.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-10T07:31:38.000Z (7 months ago)
- Last Synced: 2024-12-24T05:33:41.979Z (29 days ago)
- Topics: gatsby, gatsby-themes, style-guide, styleguide, theme-ui
- Language: JavaScript
- Homepage: https://theme-ui-styleguide.netlify.com/
- Size: 2.98 MB
- Stars: 41
- Watchers: 2
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Styleguide
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`](https://github.com/LekoArts/gatsby-themes/tree/main/themes/gatsby-theme-styleguide).
[**Demo Website**](https://theme-ui-styleguide.netlify.app)
Also be sure to check out other [Free & Open Source Gatsby Themes](https://themes.lekoarts.de) and my [Personal Website](https://www.lekoarts.de?utm_source=styleguide&utm_medium=Starter).
## ✨ 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`](https://github.com/LekoArts/gatsby-themes/tree/main/themes/gatsby-theme-specimens) under the hood. You can use components from it to extend your styleguide page
## ⏱️ Quick Start
Deploy this starter with one click on [Netlify](https://app.netlify.com/signup):
[
](https://app.netlify.com/start/deploy?repository=https://github.com/LekoArts/gatsby-starter-styleguide)
## 🚀 Getting Started
### 1. **Create a Gatsby site.**
Use the Gatsby CLI to clone the site and install dependencies:
```sh
npx gatsby new gatsby-starter-styleguide https://github.com/LekoArts/gatsby-starter-styleguide
```
### 2. **Navigate to your new project.**
```sh
cd gatsby-starter-styleguide
```
### 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](https://www.gatsbyjs.com/docs/how-to/plugins-and-themes/using-a-gatsby-theme/) or [longer](https://www.gatsbyjs.com/tutorial/using-a-theme/) 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](https://www.gatsbyjs.com/docs/how-to/plugins-and-themes/shadowing/) 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`](https://github.com/LekoArts/gatsby-themes/tree/main/themes/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](https://realfavicongenerator.net/) 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](https://www.gatsbyjs.com/contributing/community/#where-to-get-support) mentioned in Gatsby's documentation. If you have a specific question about this project, you can head to the [GitHub Discussions](https://github.com/LekoArts/gatsby-themes/discussions) of the repository.
## 🎓 Learning Gatsby
Looking for more guidance? Full documentation for Gatsby lives [on Gatsby's website](https://www.gatsbyjs.com/).
### Themes
To learn more about Gatsby themes specifically, I recommend checking out the [theme docs](https://www.gatsbyjs.com/docs/themes/).
### General
- **For most developers, I recommend starting with the [in-depth tutorial for creating a site with Gatsby](https://www.gatsbyjs.com/docs/tutorial/).** 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](https://www.gatsbyjs.com/docs/).** 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 [Bluesky](https://bsky.app/profile/lekoarts.de) and share the project with me.
Please star this project, share it on Social Media or consider supporting me on [GitHub Sponsors](https://github.com/sponsors/LekoArts)!