https://github.com/mogeko/gatsby-theme-terminal
A terminal style Gatsby theme for blog.
https://github.com/mogeko/gatsby-theme-terminal
Last synced: 6 months ago
JSON representation
A terminal style Gatsby theme for blog.
- Host: GitHub
- URL: https://github.com/mogeko/gatsby-theme-terminal
- Owner: mogeko
- License: mit
- Created: 2021-10-13T12:11:19.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-06T13:22:25.000Z (over 3 years ago)
- Last Synced: 2025-09-02T18:46:15.659Z (11 months ago)
- Language: TypeScript
- Size: 2.97 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
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-terminal
│ ├── 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-terminal`
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-terminal/`
- `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
```
## 🚀 Quick start (Gatsby Cloud)
Deploy this starter with one click on [Gatsby Cloud](https://www.gatsbyjs.com/cloud/):
[
](https://www.gatsbyjs.com/dashboard/deploynow?url=https://github.com/gatsbyjs/gatsby-starter-theme-workspace)