# @undataforum/gatsby-theme-base

> A Gatsby theme with a layout.

Latest version **0.17.0** (published 2021-03-09) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @undataforum/gatsby-theme-base
pnpm add @undataforum/gatsby-theme-base
yarn add @undataforum/gatsby-theme-base
bun add @undataforum/gatsby-theme-base
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.17.0 |
| Published | 2021-03-09 |
| First published | 2019-08-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 25.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Thilo Maier |
| Maintainers | maiertech |
| Keywords | gatsby, gatsby-theme, gatsby-plugin, undataforum |

## Links

- npm: https://www.npmjs.com/package/@undataforum/gatsby-theme-base
- Repository: https://github.com/undataforum/gatsby-themes
- Homepage: https://github.com/undataforum/gatsby-themes#readme
- Issues: https://github.com/undataforum/gatsby-themes/issues
- npm.io page: https://npm.io/package/@undataforum/gatsby-theme-base

## Dependencies (6)

- [prop-types](https://npm.io/package/prop-types.md) ^15.7.2
- [react-helmet](https://npm.io/package/react-helmet.md) ^6.1.0
- [gatsby-plugin-sitemap](https://npm.io/package/gatsby-plugin-sitemap.md) ^3.0.0
- [@maiertech/gatsby-helpers](https://npm.io/package/@maiertech/gatsby-helpers.md) ^0.3.0
- [gatsby-plugin-react-helmet](https://npm.io/package/gatsby-plugin-react-helmet.md) ^4.0.0
- [@maiertech/gatsby-theme-pages-core](https://npm.io/package/@maiertech/gatsby-theme-pages-core.md) ^0.6.0

## Recent versions

- 0.17.0 (latest) — 2021-03-09
- 0.16.0 — 2021-01-27
- 0.15.0 — 2021-01-20
- 0.14.0 — 2020-08-03
- 0.13.2 — 2020-03-27
- 0.13.1 — 2020-03-25
- 0.13.0 — 2020-03-19
- 0.12.3 — 2020-03-18
- 0.12.2 — 2020-03-09
- 0.12.1 — 2020-01-31
- 0.12.0 — 2020-01-30
- 0.11.1 — 2020-01-16
- 0.11.0 — 2020-01-14
- 0.10.3 — 2019-12-20
- 0.10.2 — 2019-12-04
- … 12 more at https://npm.io/package/@undataforum/gatsby-theme-base/versions

## README

# @undataforum/gatsby-theme-base

A [Gatsby theme](https://www.gatsbyjs.org/docs/themes/) that does the following:

1. It adds selected [Gatsby plugins](https://www.gatsbyjs.com/plugins/) that are
   required in every [@UNDataForum](https://github.com/UNDataForum) website to
   `gatsby-config.js`.

1. It exports the `SEO` component that can be used in templates to add SEO
   metadata.

1. It and generates standardized pages (from MDX files) that need to be present
   in every website.

## Options

| Option                   | Default | Description                                                                       |
| :----------------------- | :------ | :-------------------------------------------------------------------------------- |
| `mdxOtherwiseConfigured` | `false` | Set this flag to true if `gatsby-plugin-mdx` is already configured for your site. |

## Site metadata

To make the `SEO` component work, you need to define the following
[site metadata](https://www.gatsbyjs.com/docs/gatsby-config/#sitemetadata) in
your site's `gatsby-config.js`:

| Key             | Required | Description                                                              |
| :-------------- | :------- | :----------------------------------------------------------------------- |
| siteTitle       | ✓        | Site title for SEO.                                                      |
| siteDescription |          | Site description for SEO in homepage.                                    |
| siteUrl         | ✓        | URL from which the production site is served. Used for sitemap creation. |
| siteTwitter     | ✓        | Site Twitter username for SEO. Can be set to `''`.                       |
| siteLanguage    | ✓        | Default site language.                                                   |

## Plugins

This theme installs the following plugins:

| Plugin                                                                                     | Description                                                                                                             |
| :----------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------- |
| [gatsby-plugin-react-helmet](https://www.gatsbyjs.com/plugins/gatsby-plugin-react-helmet/) | Required to make the `SEO` component work.                                                                              |
| [gatsby-plugin-sitemap](https://www.gatsbyjs.com/plugins/gatsby-plugin-sitemap)            | Create a [sitemap](https://developers.google.com/search/docs/advanced/sitemaps/overview) that you can submit to Google. |

## Standardized pages

| Title          | Path               | Description                                                            |
| :------------- | :----------------- | :--------------------------------------------------------------------- |
| Contact        | `/contact/`        | Palceholder page for contact details. Needs to be shadowed in website. |
| Copyright      | `/copyright/`      | Standardized copyright notice.                                         |
| Privacy Notice | `/privacy-notice/` | Standardized privacy notice.                                           |
| Terms of USe   | `/terms-of-use/`   | Standardized terms of use.                                             |
| 404            | `/404/`            | 404 page. Can be shadowed in your site.                                |

All standardized pages are unstyled. You can style them by shadowing the
template from
[@maiertech/gatsby-theme-pages-core](https://github.com/maiertech/gatsby-themes/tree/master/packages/gatsby-theme-pages-core).

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