forked from jlengstorf/gatsby-theme-jam-example
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b8068db
commit f141f31
Showing
1 changed file
with
11 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,12 +9,16 @@ It includes: | |
|
||
## How to use this repo | ||
|
||
**NOTE:** Make sure to replace `USERNAME` `THEMENAME` with the desired name for your theme in the following instructions. | ||
**NOTE:** Make sure to replace `USERNAME` with your GitHub username and `THEMENAME` with your theme name. | ||
|
||
1. Get the theme set up locally | ||
1. Fork this repo. | ||
|
||
2. Rename the forked repo `gatsby-theme-THEMENAME`. (Make sure to replace `THEMENAME` with your chosen name.) | ||
|
||
3. Get the theme set up locally. | ||
```sh | ||
# clone the repo | ||
git clone [email protected]:USERNAME/gatsby-theme-jam-example.git gatsby-theme-THEMENAME | ||
git clone [email protected]:USERNAME/gatsby-theme-THEMENAME.git | ||
|
||
# move into the directory | ||
cd gatsby-theme-THEMENAME | ||
|
@@ -23,18 +27,18 @@ It includes: | |
yarn | ||
``` | ||
|
||
2. Start the demo site | ||
4. Start the demo site. | ||
```sh | ||
yarn workspace demo develop | ||
``` | ||
|
||
The demo will start at http://localhost:8000 | ||
|
||
3. Start editing the theme! Any changes you make to the local `theme` directory will be reflected on the demo site for easy local development. | ||
5. Start editing the theme! Any changes you make to the local `theme` directory will be reflected on the demo site for easy local development. | ||
|
||
4. Follow the [submission checklist](./theme/README.md#submission-checklist) to make sure your theme qualifies to win! | ||
6. Follow the [submission checklist](./theme/README.md#submission-checklist) to make sure your theme qualifies to win! | ||
|
||
5. [Submit your theme](https://themejam.gatsbyjs.org/submit) to win! | ||
7. [Submit your theme](https://themejam.gatsbyjs.org/submit) to win! | ||
|
||
## More information | ||
|
||
|