https://github.com/mmintel/gatsby-tina-test
https://github.com/mmintel/gatsby-tina-test
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/mmintel/gatsby-tina-test
- Owner: mmintel
- Created: 2020-03-08T15:12:50.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-03-14T14:22:41.000Z (over 6 years ago)
- Last Synced: 2025-06-05T01:00:35.080Z (about 1 year ago)
- Language: JavaScript
- Size: 298 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Starter for creating a Gatsby Theme workspace
```shell
gatsby new my-theme https://github.com/gatsbyjs/gatsby-starter-theme-workspace
cd my-theme
yarn workspace example develop
```
## Layout
```text
.
├── README.md
├── gatsby-theme-minimal
│ ├── README.md
│ ├── gatsby-config.js
│ ├── index.js
│ └── package.json
├── example
│ ├── README.md
│ ├── gatsby-config.js
│ ├── package.json
│ └── src
├── package.json
└── yarn.lock
3 directories, 10 files
```
### `gatsby-theme-minimal`
This directory is the theme package itself. You should rename this at
some point to be `gatsby-theme-{my-theme-name}`. Also change the
`package.json` name field and the corresponding dependency in the
example directory's `package.json`/`gatsby-config.js` to match the chosen name.
- `gatsby-theme-minimal/`
- `gatsby-config.js`: An empty gatsby-config that you can use as a starting point for building functionality into your theme.
- `index.js`: Since themes also function as plugins, this is an empty file that
gatsby needs to use this theme as a plugin.
- `package.json`: The dependencies that your theme will pull in when people install it. `gatsby` should be a `peerDependency`.
### `example`
This is an example usage of your theme. It should look the same as the
site of someone who installed and used your theme from npm.
- `example/`
- `gatsby-config.js`: Specifies which theme to use and any other one-off config a site might need.
- `src/`: Source code such as one-off pages or components that might live in
a user's site.
You can run the example with:
```shell
yarn workspace example develop
```