create-gatsby-theme

Create your own Gatsby theme.

It structures your repository by using yarn workspace.

It comes with an example and you can build your theme while testing it on the example, and the example can be used as a demo for your theme later.

Installation

npx create-gatsby-theme

Usage

Running example site

The following command runs the example site.

You can work on both theme and example site and will check it live on the running example site.

yarn run example

Sample Code

If you said "Yes" to Adding sample code, there should be minimum code to see how it's done. They're not committed into your repository. You can get rid of them by running the following command:

git reset --hard HEAD && git clean -fd

Release your theme

The release process is powered by Ship.js.

Especially if you maintain multiple packages, this makes it easy to manage all the releases.

To start a release process, run the following command:

yarn run release:prepare

To finish the setup of the release process, please refer to the Ship.js guide.

Netlify

If you opted in, netlify.toml is added to your repository. By default, it will allow Netlify to build and release your example site. This site can be used as a demo on the README.md of your theme repository.