Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jlengstorf/gatsby-theme-jam-example
An example submission for the Gatsby Theme Jam.
https://github.com/jlengstorf/gatsby-theme-jam-example
example gatsby gatsby-plugin gatsby-theme
Last synced: 17 days ago
JSON representation
An example submission for the Gatsby Theme Jam.
- Host: GitHub
- URL: https://github.com/jlengstorf/gatsby-theme-jam-example
- Owner: jlengstorf
- Created: 2019-07-03T02:36:49.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-07-01T03:17:32.000Z (over 3 years ago)
- Last Synced: 2024-10-26T13:41:36.458Z (18 days ago)
- Topics: example, gatsby, gatsby-plugin, gatsby-theme
- Language: JavaScript
- Homepage: https://themejam.gatsbyjs.org
- Size: 1.35 MB
- Stars: 87
- Watchers: 5
- Forks: 390
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Gatsby Theme Jam Submission Example
This repo is an example and potential starting point for theme creators.
It includes:
- a bare-bones theme (located in `theme/`) that includes basic setup
- a demo site (located in `demo/`) that installs the theme
- a Yarn workspaces configuration so the theme and demo can be worked on simultaneously
## How to use this repo
**NOTE:** Make sure to replace `USERNAME` with your GitHub username and `THEMENAME` with your theme name.
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-THEMENAME.git
# move into the directory
cd gatsby-theme-THEMENAME
# install dependencies
yarn
```
4. Update `theme/package.json` with your info.
```diff
{
+ "name": "gatsby-theme-THEMENAME",
+ "author": "Your Name ",
"repository": {
"type": "git",
+ "url": "https://github.com/USERNAME/gatsby-theme-THEMENAME.git"
},
```
5. Start the demo site.
```sh
yarn workspace demo develop
```
The demo will start at http://localhost:8000
**NOTE:** If you’re new to Yarn workspaces, check out [this post](https://www.gatsbyjs.org/blog/2019-05-22-setting-up-yarn-workspaces-for-theme-development/) for details.
6. Start editing the theme! The demo site is configured to use the local theme, so any changes you make to the local `theme` directory will be reflected on the demo site for easy local development.
7. Follow the [submission checklist](./theme/README.md#submission-checklist) to make sure your theme qualifies to win!
8. [Submit your theme](https://themejam.gatsbyjs.org/submit) to win!
## More information
For contest rules and more information, see [the Theme Jam website](https://themejam.gatsbyjs.org).