https://github.com/eunjae-lee/create-gatsby-theme

Create a gatsby theme with pre-built template
https://github.com/eunjae-lee/create-gatsby-theme

gatsby gatsby-starter gatsby-theme theme

Last synced: about 1 month ago
JSON representation

Create a gatsby theme with pre-built template

• Host: GitHub
• URL: https://github.com/eunjae-lee/create-gatsby-theme
• Owner: eunjae-lee
• Created: 2019-10-02T11:54:06.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-02-12T15:15:38.000Z (almost 3 years ago)
• Last Synced: 2024-04-25T14:20:21.656Z (8 months ago)
• Topics: gatsby, gatsby-starter, gatsby-theme, theme
• Language: JavaScript
• Homepage:
• Size: 400 KB
• Stars: 25
• Watchers: 2
• Forks: 1
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

• awesome - create-gatsby-theme - Create a gatsby theme with pre-built template (JavaScript)

README

        
# 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

```bash

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.

```bash

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:

```bash

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

```

### Release your theme

The release process is powered by [Ship.js](https://github.com/algolia/shipjs).

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

To start a release process, run the following command:

```bash

yarn run release:prepare

```

To finish the setup of the release process, please refer to the [Ship.js guide](https://github.com/algolia/shipjs/blob/master/GUIDE.md#automate-part-3-shipjs-trigger-on-your-ci).

### 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.