Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/agneym/gatsby-wedding-theme

A Simple Wedding Theme for Gatsby
https://github.com/agneym/gatsby-wedding-theme

gatsby gatsby-theme

Last synced: 3 months ago
JSON representation

A Simple Wedding Theme for Gatsby

Awesome Lists containing this project

README

        

# Gatsby Wedding Theme Workspace

A simple and easy wedding theme using Gatsby and Styled Components.

npm version

code style: prettier

[Demo](https://vigorous-ptolemy-fe8a70.netlify.com/event)

## Manual Setup

```bash
npm i @agney/gatsby-theme-wedding

# OR #
yarn add @agney/gatsby-theme-wedding
```

In your `gatsby-config.js`:

```js
module.exports = {
plugins: [
{
resolve: `@agney/gatsby-theme-wedding`,
options: {
contentPath: "occasion", // Tell the theme where your data is.
basePath: "/event" // Tell the theme which URL to render the theme at.
}
}
]
};
```

## Adding the Data

[Data Format](https://github.com/agneym/gatsby-wedding-theme/blob/master/gatsby-theme-wedding/data/event.json) - You can provide data in JSON format.

## Changing the theme

Create a `theme.js` file at `src/@agney/gatsby-theme-wedding/components/theme.js`

```js
const theme = {};

export default theme;
```

[See full properties here](https://github.com/agneym/gatsby-wedding-theme/blob/master/gatsby-theme-wedding/src/components/theme.js)

If you need to keep existing theme and edit some of the values:

```js
import merge from "lodash.merge";
import theme from "@agney/gatsby-theme-wedding";

export default merge({}, theme, {
colors: {
primary: "blue"
}
});
```

## Replacing Components (Shadowing)

[Docs](https://www.gatsbyjs.org/docs/themes/shadowing/)

## Contributing

This theme makes use of [Yarn Workspaces](https://yarnpkg.com/lang/en/docs/workspaces/)

```
yarn
yarn workspace example develop
```