Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change step 5 to 6 and add a new step 5 #1

Open
luisFilipePT opened this issue Jul 4, 2019 · 2 comments
Open

Change step 5 to 6 and add a new step 5 #1

luisFilipePT opened this issue Jul 4, 2019 · 2 comments

Comments

@luisFilipePT
Copy link

luisFilipePT commented Jul 4, 2019

I might have missed something and if thats the case just ignore :) but...
Maybe it would be useful to have a step 5 mentioning:

  1. Update demo/gatsby-config.js with your THEMENAME
 module.exports = {
-  plugins: ["gatsby-theme-jam-example"],
+  plugins: ["gatsby-theme-THEMENAME"],
 }

6.Start the demo site.
...

This way I think it would work out of the box IMO, otherwise I think it triggers an error:

 ERROR  Failed to compile with 1 errors                                                                                                                                 11:30:28 PM
⠀
 error  in ../node_modules/gatsby-theme-jam-example/src/templates/page.js
⠀
Module parse failed: Unexpected token (6:2)
   1 /**
You may need an appropriate loader to handle this file type.

🙌

PS - If the issue is confirmed I can open a PR for the fix if it helps

@raae
Copy link

raae commented Jul 7, 2019

I run into similar issues if I do a yarn after step 4. I am guessing it then installs the workspace package under the new name and things break.

Theme name should be updated in /theme/package.json, /demo/package.json and /demo/gatsby-config.js.

I am totally new to yarn, but with my little testing it seems the whole "gatsby-theme-jam-example": "*", in /demo/package.json is not needed. Either remove or add renaming to instructions for consistency.

@jlengstorf
Copy link
Owner

@luisFilipePT whoops! Thanks for bringing this up — a PR would be extremely welcome, thank you!

@raae while it's not strictly required for development, without adding the theme as a dependency for the demo site this would break when it gets deployed.

luisFilipePT added a commit to luisFilipePT/gatsby-theme-awesome-personal-site that referenced this issue Jul 8, 2019
…ctions

Add a new step 5 with update gatsby-config.js instructions and rename former step 5 to step 6

jlengstorf#1
laradevitt pushed a commit to laradevitt/gatsby-theme-molly that referenced this issue Aug 13, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants