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.

Sign up for GitHub

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

chore: update readme to add info for linking and running locally #234

Merged
merged 1 commit into from
Aug 29, 2023
Merged

chore: update readme to add info for linking and running locally #234

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions packages/gatsby-theme-iterative/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,3 +131,14 @@ others in the future.

Check out the example project in this project's monorepo, particularly
[`gatsby-config.js`](https://github.com/iterative/gatsby-theme-iterative/blob/main/packages/example/gatsby-config.js).

### Linking the local theme

If you want to test the changes to the theme locally without publishing, you can
run `yarn add @dvcorg/gatsby-theme-iterative@[/path/to/theme]` in your project,
or simply update the package.json file and change the version to
`[/path/to/theme]`, and then run `yarn develop` as normal. This will use the
local version of the theme instead of the published version.

Note: Get the absolute theme path from `packages/gatsby-theme-iterative`
directory. You can use `pwd` command to get the absolute path.