Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kickstartds/gatsby-theme-kickstartds


https://github.com/kickstartds/gatsby-theme-kickstartds

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README

        



Gatsby



Workspace for kickstartDS Gatsby theme

## Installation
```shell
yarn install
```

## Layout

```text
.
├── README.md
├── gatsby-theme-kickstartDS
│   ├── 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-kickstartDS`

- `gatsby-theme-kickstartDS/`
- `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 the kickstartDS theme. It should look the same as the
site of someone who installs and uses this 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
```