Gatsby Style Guide Guide

Overview

Gatsby Style Guide Guide is a boilerplate for creating a custom style guide for your organization’s design system. It provides an initial structure and hooks to get started with creating your own style guide. The style guide is built using Gatsby, a site generator built with React, and it can consume and display components from any source. The goal is to customize the style guide according to your needs and populate it with your content and components.

Features

• Customizable style guide for your organization’s design system
• Built with Gatsby and React for a modern and efficient development workflow
• Ability to import components from any source for easy integration

Installation

To install Gatsby Style Guide Guide, follow these steps:

1. Download or clone the files from the repository on Github.
2. Navigate to the root of the project in the command line.
3. Run the yarn command to download the project dependencies.
4. Run gatsby develop to start the project.

Please note that importing components and assets from Pattern Lab is a feature that is coming soon.

Summary

Gatsby Style Guide Guide is a boilerplate that enables you to create a custom style guide for your organization’s design system. Built with Gatsby and React, it provides an efficient development workflow and the flexibility to import components from any source. Installation is straightforward, and the customization options allow you to tailor the style guide to your specific needs.