# @jlengstorf/gatsby-theme-showcase

> Add a showcase to any site.

Latest version **1.1.0** (published 2019-08-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @jlengstorf/gatsby-theme-showcase
pnpm add @jlengstorf/gatsby-theme-showcase
yarn add @jlengstorf/gatsby-theme-showcase
bun add @jlengstorf/gatsby-theme-showcase
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2019-08-07 |
| First published | 2019-07-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 11.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Jason Lengstorf |
| Maintainers | jlengstorf |
| Keywords | gatsby, gatsby-plugin, gatsby-theme |

## Links

- npm: https://www.npmjs.com/package/@jlengstorf/gatsby-theme-showcase
- Repository: https://github.com/jlengstorf/gatsby-theme-showcase
- Issues: https://github.com/jlengstorf/gatsby-theme-showcase/issues
- npm.io page: https://npm.io/package/@jlengstorf/gatsby-theme-showcase

## Dependencies (9)

- [theme-ui](https://npm.io/package/theme-ui.md) ^0.2.16
- [react-icons](https://npm.io/package/react-icons.md) ^3.7.0
- [@emotion/core](https://npm.io/package/@emotion/core.md) ^10.0.14
- [@mdx-js/react](https://npm.io/package/@mdx-js/react.md) ^1.0.27
- [@octokit/graphql](https://npm.io/package/@octokit/graphql.md) ^3.0.1
- [parse-github-repo-url](https://npm.io/package/parse-github-repo-url.md) ^1.4.1
- [gatsby-plugin-theme-ui](https://npm.io/package/gatsby-plugin-theme-ui.md) ^0.2.6
- [gatsby-source-airtable](https://npm.io/package/gatsby-source-airtable.md) ^2.0.8
- [gatsby-source-filesystem](https://npm.io/package/gatsby-source-filesystem.md) ^2.1.5

## Recent versions

- 1.1.0 (latest) — 2019-08-07
- 1.0.5 — 2019-08-01
- 1.0.4 — 2019-08-01
- 1.0.3 — 2019-08-01
- 1.0.2 — 2019-08-01
- 1.0.1 — 2019-07-25
- 1.0.0 — 2019-07-22

## README

# Gatsby Theme Showcase

Add a showcase to any site.

## What you get from this theme

- Airtable integration
- A React component to display data

## Installation

To use this theme in your Gatsby sites, follow these instructions:

1.  Install the theme

    ```sh
    npm install --save @jlengstorf/gatsby-theme-showcase
    ```

2.  Add the theme to your `gatsby-config.js`:

    ```js
    module.exports = {
      plugins: ['@jlengstorf/gatsby-theme-showcase'],
    };
    ```

3.  Start your site
    ```sh
    gatsby develop
    ```

## Usage

### Theme options

| Key    | Default value | Description |
| ------ | ------------- | ----------- |
| `todo` |               | tkt         |

#### Example usage

```js
// gatsby-config.js
module.exports = {
  plugins: ['@jlengstorf/gatsby-theme-showcase'],
};
```

### Exported components

#### `Showcase`

[description of what this is and why it's useful]

#### Example usage in MDX

In any MDX file:

```mdx
import { Showcase } from '@jlengstorf/gatsby-theme-showcase';

# Look at my photos!

<Showcase />
```

#### Example usage in React components

In any React component:

```jsx
import React from 'react';
import { Showcase } from '@jlengstorf/gatsby-theme-showcase';

export default () => (
  <div>
    <Showcase />
  </div>
);
```

#### How to shadow this component

If you want to use [component shadowing](https://www.gatsbyjs.org/blog/2019-04-29-component-shadowing/) with this component, create a file at the following path in your site:

```
src/@jlengstorf/gatsby-theme-showcase/components/showcase.js
```

---
_Source: https://npm.io/package/@jlengstorf/gatsby-theme-showcase · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
